diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 2b51a42e7..c52d5bf0a 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -3200,12 +3204,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3251,98 +3249,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-validity" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -3442,6 +3348,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -3841,6 +3757,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -3938,6 +4184,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -7253,10 +7509,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -7906,6 +8277,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -7924,6 +8300,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -7976,17 +8357,17 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -8011,14 +8392,14 @@ "images": { "type": "array", "items": { - "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" } } } }, "examples": { "default": { - "$ref": "#/components/examples/actions-hosted-runner-curated-image" + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" } } } @@ -8033,17 +8414,292 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/get-custom-image-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -8342,6 +8998,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -12734,6 +13395,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -13228,7 +13960,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -13239,8 +13972,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16388,12 +17132,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -22991,16 +23729,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -23177,16 +23921,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -44273,16 +45023,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -44298,12 +45038,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61344,7 +62078,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -74895,16 +75629,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -75072,16 +75812,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -75625,7 +76371,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -101744,6 +102490,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -101941,6 +102695,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -104690,483 +105453,6 @@ ], "additionalProperties": false }, - "nullable-alert-updated-at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "secret-scanning-alert-resolution": { - "type": "string", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - }, - "nullable-secret-scanning-first-detected-location": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "$ref": "#/components/schemas/secret-scanning-location-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - } - ], - "nullable": true - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { - "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - }, - "first_location_detected": { - "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - }, - "assigned_to": { - "$ref": "#/components/schemas/nullable-simple-user" - } - } - }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -105238,6 +105524,79 @@ "group_id" ] }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, "actor": { "title": "Actor", "description": "Actor", @@ -109026,79 +109385,6 @@ "subscribed" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -109422,6 +109708,36 @@ }, "additionalProperties": false }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -109487,7 +109803,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -109495,7 +109811,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -109503,7 +109819,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -110032,6 +110348,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -110164,6 +110485,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -110176,6 +110501,102 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -110861,6 +111282,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "nullable-team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -115672,36 +116102,6 @@ "value_type" ] }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "nullable": true - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -118540,6 +118940,483 @@ } ] }, + "nullable-alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ], + "nullable": true + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "The comment that was optionally added when this alert was closed", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "$ref": "#/components/schemas/nullable-simple-user" + } + } + }, "secret-scanning-row-version": { "type": "string", "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", @@ -136063,7 +136940,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -136071,7 +136948,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -136079,7 +136956,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -279891,192 +280768,6 @@ } ] }, - "organization-secret-scanning-alert-list": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, "enterprise-teams-items": { "value": [ { @@ -280139,6 +280830,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -281659,24 +282384,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -281755,6 +282462,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -281980,6 +282721,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -283043,6 +283823,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -287929,6 +288721,192 @@ } ] }, + "organization-secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -299377,40 +300355,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -309091,113 +310035,6 @@ "default": "created" } }, - "pagination-first": { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - "pagination-last": { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, - "secret-scanning-alert-state": { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - "secret-scanning-alert-secret-type": { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-resolution": { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-sort": { - "name": "sort", - "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - "secret-scanning-alert-validity": { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-publicly-leaked": { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - "secret-scanning-alert-multi-repo": { - "name": "is_multi_repo", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - "secret-scanning-alert-hide-secret": { - "name": "hide_secret", - "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, "enterprise-team": { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", @@ -309216,6 +310053,15 @@ "type": "string" } }, + "org": { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -309360,15 +310206,6 @@ "type": "integer" } }, - "org": { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -309441,6 +310278,25 @@ "type": "integer" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -310028,6 +310884,51 @@ "type": "integer" } }, + "secret-scanning-alert-state": { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + "secret-scanning-alert-secret-type": { + "name": "secret_type", + "in": "query", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-resolution": { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-sort": { + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, "secret-scanning-pagination-before-org-repo": { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", @@ -310046,6 +310947,45 @@ "type": "string" } }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-publicly-leaked": { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-multi-repo": { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-hide-secret": { + "name": "hide_secret", + "in": "query", + "description": "A boolean value representing whether or not to hide literal secrets in the results.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 9427653ab..6810036c8 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -2296,8 +2298,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2325,61 +2325,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/pagination-before" - - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/secret-scanning-alert-validity" - - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" - examples: - default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -2452,6 +2397,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -2698,6 +2655,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -2771,6 +2931,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -5113,12 +5285,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -5677,6 +5944,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5694,6 +5966,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -5725,6 +6002,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -5981,6 +6449,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -9182,6 +9655,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -9541,6 +10061,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -9550,7 +10071,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11933,8 +12458,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -16635,16 +17158,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -16756,16 +17282,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -32235,14 +32764,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -32253,8 +32774,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -44484,6 +45003,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -54263,16 +54785,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54380,16 +54905,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54750,7 +55278,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -73506,6 +74037,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -73682,6 +74220,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -75976,388 +76522,6 @@ components: - fixed_at - repository additionalProperties: false - nullable-alert-updated-at: - type: string - description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - secret-scanning-alert-state: - description: Sets the state of the secret scanning alert. You must provide `resolution` - when you set the state to `resolved`. - type: string - enum: - - open - - resolved - secret-scanning-alert-resolution: - type: string - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - nullable-secret-scanning-first-detected-location: - description: 'Details on the location where the token was initially detected. - This can be a commit, wiki commit, issue, discussion, pull request. - - ' - oneOf: - - "$ref": "#/components/schemas/secret-scanning-location-commit" - - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - nullable: true - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - "$ref": "#/components/schemas/nullable-alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - "$ref": "#/components/schemas/nullable-simple-user" - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: - type: string - description: The secret that was detected. - repository: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected secret. - nullable: true - push_protection_bypassed_by: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: - type: string - description: The comment that was optionally added when this alert was closed - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple repositories - in the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert is base64 - encoded - nullable: true - first_location_detected: - "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" - has_more_locations: - type: boolean - description: A boolean value representing whether or not the token in the - alert was detected in more than one location. - assigned_to: - "$ref": "#/components/schemas/nullable-simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76415,6 +76579,64 @@ components: - created_at - updated_at - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description actor: title: Actor description: Actor @@ -79284,64 +79506,6 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -79634,6 +79798,25 @@ components: items: "$ref": "#/components/schemas/nullable-simple-repository" additionalProperties: false + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value billing-premium-request-usage-report-org: type: object properties: @@ -79684,19 +79867,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -80147,6 +80330,10 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest required: - id - size_gb @@ -80254,6 +80441,9 @@ components: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80262,6 +80452,84 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -80811,6 +81079,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -84674,25 +84949,6 @@ components: description: Who can edit the values of the property required: - value_type - custom-property-value: - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86896,6 +87152,388 @@ components: state: type: object description: The state of the ruleset version + nullable-alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + secret-scanning-alert-state: + description: Sets the state of the secret scanning alert. You must provide `resolution` + when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: string + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/nullable-alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + "$ref": "#/components/schemas/nullable-simple-user" secret-scanning-row-version: type: string description: The version of the entity. This is used to confirm you're updating @@ -100257,19 +100895,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -209330,181 +209968,6 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} - organization-secret-scanning-alert-list: - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: active - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false enterprise-teams-items: value: - id: 1 @@ -209557,6 +210020,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -210932,20 +211423,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization dependabot-repository-access-details: value: default_level: public @@ -211018,6 +211495,23 @@ components: teams_url: https://api.github.com/repos/octocat/example-repo/teams trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -211199,6 +211693,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -212043,6 +212565,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -216265,6 +216793,181 @@ components: parameters: operator: contains pattern: github + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -226034,23 +226737,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -234545,109 +235231,6 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - secret-scanning-alert-state: - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - secret-scanning-alert-secret-type: - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default secret - patterns are returned. To return generic patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - secret-scanning-alert-resolution: - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false - schema: - type: string - secret-scanning-alert-sort: - name: sort - description: The property to sort the results by. `created` means when the alert - was created. `updated` means when the alert was updated or resolved. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - secret-scanning-alert-validity: - name: validity - in: query - description: A comma-separated list of validities that, when present, will return - alerts that match the validities in this list. Valid options are `active`, - `inactive`, and `unknown`. - required: false - schema: - type: string - secret-scanning-alert-publicly-leaked: - name: is_publicly_leaked - in: query - description: A boolean value representing whether or not to filter alerts by - the publicly-leaked tag being present. - required: false - schema: - type: boolean - default: false - secret-scanning-alert-multi-repo: - name: is_multi_repo - in: query - description: A boolean value representing whether or not to filter alerts by - the multi-repo tag being present. - required: false - schema: - type: boolean - default: false - secret-scanning-alert-hide-secret: - name: hide_secret - in: query - description: A boolean value representing whether or not to hide literal secrets - in the results. - required: false - schema: - type: boolean - default: false enterprise-team: name: enterprise-team description: The slug version of the enterprise team name. You can also substitute @@ -234663,6 +235246,13 @@ components: required: true schema: type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -234784,13 +235374,6 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -234857,6 +235440,21 @@ components: required: false schema: type: integer + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -235364,6 +235962,48 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return generic patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-sort: + name: sort + description: The property to sort the results by. `created` means when the alert + was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created secret-scanning-pagination-before-org-repo: name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). @@ -235382,6 +236022,42 @@ components: required: false schema: type: string + secret-scanning-alert-validity: + name: validity + in: query + description: A comma-separated list of validities that, when present, will return + alerts that match the validities in this list. Valid options are `active`, + `inactive`, and `unknown`. + required: false + schema: + type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts by + the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts by + the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 2b51a42e7..c52d5bf0a 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -3200,12 +3204,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3251,98 +3249,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-validity" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -3442,6 +3348,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -3841,6 +3757,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -3938,6 +4184,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -7253,10 +7509,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -7906,6 +8277,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -7924,6 +8300,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -7976,17 +8357,17 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "/orgs/{org}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -8011,14 +8392,14 @@ "images": { "type": "array", "items": { - "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" } } } }, "examples": { "default": { - "$ref": "#/components/examples/actions-hosted-runner-curated-image" + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" } } } @@ -8033,17 +8414,292 @@ } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { "get": { - "summary": "Get partner images for GitHub-hosted runners in an organization", - "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", - "operationId": "actions/get-hosted-runners-partner-images-for-org", + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/get-custom-image-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -8342,6 +8998,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -12734,6 +13395,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -13228,7 +13960,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -13239,8 +13972,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16388,12 +17132,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -22991,16 +23729,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -23177,16 +23921,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -44273,16 +45023,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -44298,12 +45038,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61344,7 +62078,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -74895,16 +75629,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -75072,16 +75812,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -75625,7 +76371,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -101744,6 +102490,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -101941,6 +102695,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -104690,483 +105453,6 @@ ], "additionalProperties": false }, - "nullable-alert-updated-at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "secret-scanning-alert-state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "secret-scanning-alert-resolution": { - "type": "string", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - }, - "nullable-secret-scanning-first-detected-location": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "$ref": "#/components/schemas/secret-scanning-location-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - }, - { - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - } - ], - "nullable": true - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { - "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - }, - "first_location_detected": { - "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - }, - "assigned_to": { - "$ref": "#/components/schemas/nullable-simple-user" - } - } - }, "enterprise-team": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", @@ -105238,6 +105524,79 @@ "group_id" ] }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, "actor": { "title": "Actor", "description": "Actor", @@ -109026,79 +109385,6 @@ "subscribed" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -109422,6 +109708,36 @@ }, "additionalProperties": false }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -109487,7 +109803,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -109495,7 +109811,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -109503,7 +109819,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -110032,6 +110348,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -110164,6 +110485,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -110176,6 +110501,102 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -110861,6 +111282,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "nullable-team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -115672,36 +116102,6 @@ "value_type" ] }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "nullable": true - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -118540,6 +118940,483 @@ } ] }, + "nullable-alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ], + "nullable": true + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "The comment that was optionally added when this alert was closed", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "$ref": "#/components/schemas/nullable-simple-user" + } + } + }, "secret-scanning-row-version": { "type": "string", "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", @@ -136063,7 +136940,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -136071,7 +136948,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -136079,7 +136956,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -279891,192 +280768,6 @@ } ] }, - "organization-secret-scanning-alert-list": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, "enterprise-teams-items": { "value": [ { @@ -280139,6 +280830,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -281659,24 +282384,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "dependabot-repository-access-details": { "value": { "default_level": "public", @@ -281755,6 +282462,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -281980,6 +282721,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -283043,6 +283823,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -287929,6 +288721,192 @@ } ] }, + "organization-secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -299377,40 +300355,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -309091,113 +310035,6 @@ "default": "created" } }, - "pagination-first": { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - "pagination-last": { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, - "secret-scanning-alert-state": { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - "secret-scanning-alert-secret-type": { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-resolution": { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-sort": { - "name": "sort", - "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - "secret-scanning-alert-validity": { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - "secret-scanning-alert-publicly-leaked": { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - "secret-scanning-alert-multi-repo": { - "name": "is_multi_repo", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - "secret-scanning-alert-hide-secret": { - "name": "hide_secret", - "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, "enterprise-team": { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", @@ -309216,6 +310053,15 @@ "type": "string" } }, + "org": { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -309360,15 +310206,6 @@ "type": "integer" } }, - "org": { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -309441,6 +310278,25 @@ "type": "integer" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -310028,6 +310884,51 @@ "type": "integer" } }, + "secret-scanning-alert-state": { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + "secret-scanning-alert-secret-type": { + "name": "secret_type", + "in": "query", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-resolution": { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-sort": { + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, "secret-scanning-pagination-before-org-repo": { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", @@ -310046,6 +310947,45 @@ "type": "string" } }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-publicly-leaked": { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-multi-repo": { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-hide-secret": { + "name": "hide_secret", + "in": "query", + "description": "A boolean value representing whether or not to hide literal secrets in the results.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 9427653ab..6810036c8 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -2296,8 +2298,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2325,61 +2325,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/pagination-before" - - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/secret-scanning-alert-validity" - - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" - examples: - default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -2452,6 +2397,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -2698,6 +2655,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -2771,6 +2931,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -5113,12 +5285,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -5677,6 +5944,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5694,6 +5966,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -5725,6 +6002,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -5981,6 +6449,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -9182,6 +9655,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -9541,6 +10061,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -9550,7 +10071,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11933,8 +12458,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -16635,16 +17158,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -16756,16 +17282,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -32235,14 +32764,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -32253,8 +32774,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -44484,6 +45003,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -54263,16 +54785,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54380,16 +54905,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54750,7 +55278,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -73506,6 +74037,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -73682,6 +74220,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -75976,388 +76522,6 @@ components: - fixed_at - repository additionalProperties: false - nullable-alert-updated-at: - type: string - description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - secret-scanning-alert-state: - description: Sets the state of the secret scanning alert. You must provide `resolution` - when you set the state to `resolved`. - type: string - enum: - - open - - resolved - secret-scanning-alert-resolution: - type: string - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - nullable-secret-scanning-first-detected-location: - description: 'Details on the location where the token was initially detected. - This can be a commit, wiki commit, issue, discussion, pull request. - - ' - oneOf: - - "$ref": "#/components/schemas/secret-scanning-location-commit" - - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" - nullable: true - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - "$ref": "#/components/schemas/nullable-alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - "$ref": "#/components/schemas/nullable-simple-user" - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: - type: string - description: The secret that was detected. - repository: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected secret. - nullable: true - push_protection_bypassed_by: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: - type: string - description: The comment that was optionally added when this alert was closed - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple repositories - in the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert is base64 - encoded - nullable: true - first_location_detected: - "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" - has_more_locations: - type: boolean - description: A boolean value representing whether or not the token in the - alert was detected in more than one location. - assigned_to: - "$ref": "#/components/schemas/nullable-simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76415,6 +76579,64 @@ components: - created_at - updated_at - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description actor: title: Actor description: Actor @@ -79284,64 +79506,6 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -79634,6 +79798,25 @@ components: items: "$ref": "#/components/schemas/nullable-simple-repository" additionalProperties: false + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value billing-premium-request-usage-report-org: type: object properties: @@ -79684,19 +79867,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -80147,6 +80330,10 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest required: - id - size_gb @@ -80254,6 +80441,9 @@ components: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80262,6 +80452,84 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -80811,6 +81079,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -84674,25 +84949,6 @@ components: description: Who can edit the values of the property required: - value_type - custom-property-value: - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86896,6 +87152,388 @@ components: state: type: object description: The state of the ruleset version + nullable-alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + secret-scanning-alert-state: + description: Sets the state of the secret scanning alert. You must provide `resolution` + when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: string + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/nullable-alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + "$ref": "#/components/schemas/nullable-simple-user" secret-scanning-row-version: type: string description: The version of the entity. This is used to confirm you're updating @@ -100257,19 +100895,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -209330,181 +209968,6 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} - organization-secret-scanning-alert-list: - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: active - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false enterprise-teams-items: value: - id: 1 @@ -209557,6 +210020,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -210932,20 +211423,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization dependabot-repository-access-details: value: default_level: public @@ -211018,6 +211495,23 @@ components: teams_url: https://api.github.com/repos/octocat/example-repo/teams trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -211199,6 +211693,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -212043,6 +212565,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -216265,6 +216793,181 @@ components: parameters: operator: contains pattern: github + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -226034,23 +226737,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -234545,109 +235231,6 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - secret-scanning-alert-state: - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - secret-scanning-alert-secret-type: - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default secret - patterns are returned. To return generic patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - secret-scanning-alert-resolution: - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false - schema: - type: string - secret-scanning-alert-sort: - name: sort - description: The property to sort the results by. `created` means when the alert - was created. `updated` means when the alert was updated or resolved. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - secret-scanning-alert-validity: - name: validity - in: query - description: A comma-separated list of validities that, when present, will return - alerts that match the validities in this list. Valid options are `active`, - `inactive`, and `unknown`. - required: false - schema: - type: string - secret-scanning-alert-publicly-leaked: - name: is_publicly_leaked - in: query - description: A boolean value representing whether or not to filter alerts by - the publicly-leaked tag being present. - required: false - schema: - type: boolean - default: false - secret-scanning-alert-multi-repo: - name: is_multi_repo - in: query - description: A boolean value representing whether or not to filter alerts by - the multi-repo tag being present. - required: false - schema: - type: boolean - default: false - secret-scanning-alert-hide-secret: - name: hide_secret - in: query - description: A boolean value representing whether or not to hide literal secrets - in the results. - required: false - schema: - type: boolean - default: false enterprise-team: name: enterprise-team description: The slug version of the enterprise team name. You can also substitute @@ -234663,6 +235246,13 @@ components: required: true schema: type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -234784,13 +235374,6 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -234857,6 +235440,21 @@ components: required: false schema: type: integer + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -235364,6 +235962,48 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return generic patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-sort: + name: sort + description: The property to sort the results by. `created` means when the alert + was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created secret-scanning-pagination-before-org-repo: name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). @@ -235382,6 +236022,42 @@ components: required: false schema: type: string + secret-scanning-alert-validity: + name: validity + in: query + description: A comma-separated list of validities that, when present, will return + alerts that match the validities in this list. Valid options are `active`, + `inactive`, and `unknown`. + required: false + schema: + type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts by + the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts by + the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 744d87ec2..4337ba53d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -4882,6 +4886,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -5079,6 +5091,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -5826,6 +5847,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6023,6 +6052,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -6624,6 +6662,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6821,6 +6867,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -7053,6 +7108,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -7250,6 +7313,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -9037,6 +9109,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -9234,6 +9314,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -10032,6 +10121,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -10229,6 +10326,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -10944,6 +11050,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11141,6 +11255,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -11567,6 +11690,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11764,6 +11895,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -20480,29 +20620,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -22110,1758 +22227,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "is_multi_repo", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "hide_secret", - "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": "string", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { - "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - }, - "first_location_detected": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ], - "nullable": true - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - }, - "assigned_to": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -24092,6 +22457,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -25406,6 +23781,772 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -25634,6 +24775,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -65202,10 +64353,377 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + }, + "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": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "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", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -65349,7 +64867,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -65357,7 +64875,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -65365,7 +64883,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -67564,6 +67082,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -67667,6 +67190,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -67807,6 +67334,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -67825,6 +67357,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -67905,6 +67442,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -68008,6 +67550,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -68063,6 +67609,587 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, + "examples": { + "default": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -68612,6 +68739,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -68715,6 +68847,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -68830,6 +68966,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -68899,6 +69040,261 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -69002,247 +69398,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "example": true - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -74717,6 +74876,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -74820,6 +74984,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -83791,6 +83959,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -85346,7 +85618,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -85357,8 +85630,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -100085,29 +100369,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -117424,6 +117685,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -117621,6 +117890,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -118383,6 +118661,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -118580,6 +118866,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -148274,16 +148569,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -155438,16 +155739,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -304039,16 +304346,6 @@ "default": "desc" } }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -304076,29 +304373,6 @@ "schema": { "type": "string" } - }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "responses": { @@ -340316,6 +340590,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -340513,6 +340795,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -488890,7 +489181,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -557033,6 +557324,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -557230,6 +557529,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -617170,6 +617478,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -617367,6 +617683,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -624057,16 +624382,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -631194,16 +631525,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -655215,7 +655552,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -655346,7 +655683,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -655354,7 +655691,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -655362,7 +655699,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -796595,6 +796932,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -796792,6 +797137,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -799146,6 +799500,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -799343,6 +799705,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -801604,6 +801975,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -801801,6 +802180,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -804062,6 +804450,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -804259,6 +804655,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -806652,6 +807057,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -806849,6 +807262,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -809249,6 +809671,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -809446,6 +809876,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -813469,6 +813908,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -813666,6 +814113,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f6e9af8bd..fafcda969 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -855,7 +857,7 @@ paths: - subscriptions_url - type - url - type: &307 + type: &302 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &629 + - &634 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1139,7 +1141,7 @@ paths: GitHub. type: object nullable: true - properties: &68 + properties: &67 id: description: Unique identifier of the GitHub app example: 37 @@ -1272,7 +1274,7 @@ paths: about itself. example: 5 type: integer - required: &69 + required: &68 - id - node_id - owner @@ -1577,7 +1579,7 @@ paths: schema: type: integer default: 30 - - &187 + - &194 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1593,7 +1595,7 @@ paths: application/json: schema: type: array - items: &188 + items: &195 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1673,7 +1675,7 @@ paths: - installation_id - repository_id examples: - default: &189 + default: &196 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1801,7 +1803,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &197 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1915,7 +1917,7 @@ paths: - request - response examples: - default: &191 + default: &198 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2116,7 +2118,7 @@ paths: parameters: - *17 - *19 - - &79 + - &77 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2360,6 +2362,14 @@ paths: token to update GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token to view and edit custom properties for an organization, + when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access @@ -2540,6 +2550,15 @@ paths: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token for organization custom properties management at + the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -2653,7 +2672,7 @@ paths: suspended_at: suspended_by: headers: - Link: &58 + Link: &54 example: ; rel="next", ; rel="last" schema: @@ -2842,11 +2861,11 @@ paths: - selected repositories: type: array - items: &67 + items: &66 title: Repository description: A repository on GitHub. type: object - properties: &263 + properties: &268 id: description: Unique identifier of the repository example: 42 @@ -2866,7 +2885,7 @@ paths: title: License Simple description: License Simple type: object - properties: &74 + properties: &73 key: type: string example: mit @@ -2888,7 +2907,7 @@ paths: html_url: type: string format: uri - required: &75 + required: &74 - key - name - url @@ -3284,7 +3303,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &264 + required: &269 - archive_url - assignees_url - blobs_url @@ -5071,7 +5090,7 @@ paths: responses: '202': *39 '422': *7 - '500': &106 + '500': &105 description: Internal Error content: application/json: @@ -7395,7 +7414,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &159 + code_scanning_options: &168 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7589,7 +7608,7 @@ paths: description: Response content: application/json: - schema: &161 + schema: &170 type: array description: A list of default code security configurations items: @@ -7605,7 +7624,7 @@ paths: default configuration: *43 examples: - default: &162 + default: &171 value: - default_for_new_repos: public configuration: @@ -7936,7 +7955,7 @@ paths: - *42 - *45 responses: - '204': &163 + '204': &172 description: A header with no content is returned. '400': *14 '403': *29 @@ -8063,7 +8082,7 @@ paths: default: value: default_for_new_repos: all - configuration: &160 + configuration: &169 value: id: 1325 target_type: organization @@ -8148,7 +8167,7 @@ paths: application/json: schema: type: array - items: &164 + items: &173 type: object description: Repositories associated with a code security configuration and attachment status @@ -8170,7 +8189,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &103 + properties: &102 id: type: integer format: int64 @@ -8397,7 +8416,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &104 + required: &103 - archive_url - assignees_url - blobs_url @@ -8449,7 +8468,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &165 + repository: &174 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8543,7 +8562,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &170 + - &179 name: state in: query description: |- @@ -8552,7 +8571,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &171 + - &180 name: severity in: query description: |- @@ -8561,7 +8580,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &172 + - &181 name: ecosystem in: query description: |- @@ -8570,14 +8589,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &173 + - &182 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &174 + - &183 name: epss_percentage in: query description: |- @@ -8589,7 +8608,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &479 + - &474 name: has in: query description: |- @@ -8603,7 +8622,7 @@ paths: type: string enum: - patch - - &175 + - &184 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8613,7 +8632,7 @@ paths: enum: - development - runtime - - &176 + - &185 name: sort in: query description: |- @@ -8631,31 +8650,6 @@ paths: - *48 - *40 - *41 - - &177 - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - &178 - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - *17 responses: '200': @@ -8664,11 +8658,11 @@ paths: application/json: schema: type: array - items: &179 + items: &186 type: object description: A Dependabot alert. properties: - number: &54 + number: &158 type: integer description: The security alert number. readOnly: true @@ -8730,7 +8724,7 @@ paths: - unknown - direct - transitive - security_advisory: &480 + security_advisory: &475 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8933,29 +8927,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *52 - url: &56 + url: &161 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &57 + html_url: &162 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &55 + created_at: &159 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &153 + updated_at: &160 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &155 + dismissed_at: &164 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8985,14 +8979,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &154 + fixed_at: &163 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &481 + auto_dismissed_at: &476 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9018,7 +9012,7 @@ paths: - repository additionalProperties: false examples: - default: &180 + default: &187 value: - number: 2 state: dismissed @@ -9346,718 +9340,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - *42 - - &295 - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - - &296 - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default - secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - - &297 - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false - schema: - type: string - - &298 - name: sort - description: The property to sort the results by. `created` means when the - alert was created. `updated` means when the alert was updated or resolved. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - *48 - - *17 - - *40 - - *41 - - &299 - name: validity - in: query - description: A comma-separated list of validities that, when present, will - return alerts that match the validities in this list. Valid options are - `active`, `inactive`, and `unknown`. - required: false - schema: - type: string - - &300 - name: is_publicly_leaked - in: query - description: A boolean value representing whether or not to filter alerts - by the publicly-leaked tag being present. - required: false - schema: - type: boolean - default: false - - &301 - name: is_multi_repo - in: query - description: A boolean value representing whether or not to filter alerts - by the multi-repo tag being present. - required: false - schema: - type: boolean - default: false - - &302 - name: hide_secret - in: query - description: A boolean value representing whether or not to hide literal secrets - in the results. - required: false - schema: - type: boolean - default: false - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &303 - type: object - properties: - number: *54 - created_at: *55 - updated_at: - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - url: *56 - html_url: *57 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: &607 - description: Sets the state of the secret scanning alert. You - must provide `resolution` when you set the state to `resolved`. - type: string - enum: - - open - - resolved - resolution: &608 - type: string - description: "**Required when the `state` is `resolved`.** The - reason for resolving the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: - type: string - description: The secret that was detected. - repository: *53 - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected - secret. - nullable: true - push_protection_bypassed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection - bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection - bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: - type: string - description: The comment that was optionally added when this - alert was closed - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple - repositories in the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert - is base64 encoded - nullable: true - first_location_detected: - description: 'Details on the location where the token was initially - detected. This can be a commit, wiki commit, issue, discussion, - pull request. - - ' - oneOf: &609 - - &611 - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - &612 - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - &613 - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - &614 - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - &615 - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - &616 - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - &617 - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - &618 - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - &619 - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - &620 - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - &621 - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - &622 - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - &623 - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - nullable: true - has_more_locations: - type: boolean - description: A boolean value representing whether or not the - token in the alert was detected in more than one location. - assigned_to: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - examples: - default: &304 - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: active - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *58 - '404': *6 - '503': &77 - description: Service unavailable - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -10079,7 +9361,7 @@ paths: application/json: schema: type: array - items: &59 + items: &55 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10137,7 +9419,7 @@ paths: - updated_at - group_id examples: - default: &60 + default: &56 value: - id: 1 name: Justice League @@ -10150,7 +9432,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10193,6 +9475,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10211,9 +9505,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10231,7 +9525,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *42 - - &61 + - &57 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10250,7 +9544,7 @@ paths: type: array items: *4 examples: - default: &62 + default: &58 value: - login: octocat id: 1 @@ -10271,7 +9565,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10289,7 +9583,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *42 - - *61 + - *57 requestBody: required: true content: @@ -10320,7 +9614,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10338,7 +9632,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *42 - - *61 + - *57 requestBody: required: true content: @@ -10369,7 +9663,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10387,8 +9681,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *42 - - *61 - - &63 + - *57 + - &59 name: username description: The handle for the GitHub user account. in: path @@ -10402,7 +9696,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &64 + exampleKey1: &60 value: login: octocat id: 1 @@ -10438,8 +9732,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *42 - - *61 - - *63 + - *57 + - *59 responses: '201': description: Successfully added team member @@ -10447,7 +9741,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *64 + exampleKey1: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10465,8 +9759,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *42 - - *61 - - *63 + - *57 + - *59 responses: '204': description: Response @@ -10476,6 +9770,290 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - *42 + - *57 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: &61 + title: Organization Simple + description: A GitHub organization. + type: object + properties: &176 + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: &177 + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + examples: + default: &62 + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - *42 + - *57 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: *61 + examples: + default: &101 + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - *42 + - *57 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - *42 + - *57 + - &63 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *61 + examples: + default: *62 + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - *42 + - *57 + - *63 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *61 + examples: + default: *62 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - *42 + - *57 + - *63 + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -10491,7 +10069,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *42 - - &65 + - &64 name: team_slug description: The slug of the team name. in: path @@ -10503,11 +10081,11 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10525,7 +10103,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *42 - - *65 + - *64 requestBody: required: true content: @@ -10551,6 +10129,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10568,11 +10158,11 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10593,7 +10183,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *42 - - *65 + - *64 responses: '204': description: Response @@ -10631,7 +10221,7 @@ paths: application/json: schema: type: array - items: &98 + items: &96 title: Event description: Event type: object @@ -10641,7 +10231,7 @@ paths: type: type: string nullable: true - actor: &66 + actor: &65 title: Actor description: Actor type: object @@ -10681,7 +10271,7 @@ paths: - id - name - url - org: *66 + org: *65 payload: oneOf: - title: CreateEvent @@ -10727,7 +10317,7 @@ paths: properties: action: type: string - discussion: &724 + discussion: &728 title: Discussion description: A Discussion in a repository. type: object @@ -11014,7 +10604,7 @@ paths: - id labels: type: array - items: &70 + items: &69 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11089,12 +10679,12 @@ paths: properties: action: type: string - issue: &71 + issue: &70 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &529 + properties: &524 id: type: integer format: int64 @@ -11208,7 +10798,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &250 + properties: &256 url: type: string format: uri @@ -11278,7 +10868,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &251 + required: &257 - closed_issues - creator - description @@ -11357,7 +10947,7 @@ paths: timeline_url: type: string format: uri - type: &209 + type: &216 title: Issue Type description: The type of issue. type: object @@ -11407,7 +10997,7 @@ paths: - node_id - name - description - repository: *67 + repository: *66 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11418,9 +11008,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - author_association: &72 + properties: *67 + required: *68 + author_association: &71 title: author_association type: string example: OWNER @@ -11435,7 +11025,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &73 + reactions: &72 title: Reaction Rollup type: object properties: @@ -11471,7 +11061,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &641 + sub_issues_summary: &646 title: Sub-issues Summary type: object properties: @@ -11491,7 +11081,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &642 + issue_dependencies_summary: &647 title: Issue Dependencies Summary type: object properties: @@ -11510,7 +11100,7 @@ paths: - total_blocking issue_field_values: type: array - items: &643 + items: &648 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11571,7 +11161,7 @@ paths: - node_id - data_type - value - required: &530 + required: &525 - assignee - closed_at - comments @@ -11596,10 +11186,10 @@ paths: assignees: type: array items: *4 - label: *70 + label: *69 labels: type: array - items: *70 + items: *69 required: - action - issue @@ -11608,8 +11198,8 @@ paths: properties: action: type: string - issue: *71 - comment: &527 + issue: *70 + comment: &522 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11657,7 +11247,7 @@ paths: issue_url: type: string format: uri - author_association: *72 + author_association: *71 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11668,9 +11258,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - id - node_id @@ -11843,8 +11433,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true allow_forking: type: boolean @@ -11933,7 +11523,7 @@ paths: type: string number: type: integer - pull_request: &76 + pull_request: &75 title: Pull Request Minimal type: object properties: @@ -12004,10 +11594,10 @@ paths: assignees: type: array items: *4 - label: *70 + label: *69 labels: type: array - items: *70 + items: *69 required: - action - number @@ -12017,7 +11607,7 @@ paths: properties: action: type: string - pull_request: *76 + pull_request: *75 comment: type: object properties: @@ -12268,7 +11858,7 @@ paths: - pull_request updated_at: type: string - pull_request: *76 + pull_request: *75 required: - action - review @@ -12317,7 +11907,7 @@ paths: updated_at: type: string format: date-time - reactions: *73 + reactions: *72 required: - action - comment @@ -12328,7 +11918,7 @@ paths: type: string release: allOf: - - &582 + - &579 title: Release description: A release. type: object @@ -12399,7 +11989,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &580 title: Release Asset description: Data related to a release. type: object @@ -12474,7 +12064,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *73 + reactions: *72 required: - assets_url - upload_url @@ -12566,7 +12156,19 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *77 + '503': &106 + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12647,7 +12249,7 @@ paths: _links: type: object properties: - timeline: &78 + timeline: &76 title: Link With Type description: Hypermedia Link with Type type: object @@ -12659,17 +12261,17 @@ paths: required: - href - type - user: *78 - security_advisories: *78 - current_user: *78 - current_user_public: *78 - current_user_actor: *78 - current_user_organization: *78 + user: *76 + security_advisories: *76 + current_user: *76 + current_user_public: *76 + current_user_actor: *76 + current_user_organization: *76 current_user_organizations: type: array - items: *78 - repository_discussions: *78 - repository_discussions_category: *78 + items: *76 + repository_discussions: *76 + repository_discussions_category: *76 required: - timeline - user @@ -12731,7 +12333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *79 + - *77 - *17 - *19 responses: @@ -12741,7 +12343,7 @@ paths: application/json: schema: type: array - items: &80 + items: &78 title: Base Gist description: Base Gist type: object @@ -12840,7 +12442,7 @@ paths: - created_at - updated_at examples: - default: &81 + default: &79 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -12885,7 +12487,7 @@ paths: site_admin: false truncated: false headers: - Link: *58 + Link: *54 '304': *37 '403': *29 x-github: @@ -12961,7 +12563,7 @@ paths: description: Response content: application/json: - schema: &82 + schema: &80 title: Gist Simple description: Gist Simple type: object @@ -12978,7 +12580,7 @@ paths: url: type: string format: uri - user: &655 + user: &660 title: Public User description: Public User type: object @@ -13340,7 +12942,7 @@ paths: truncated: type: boolean examples: - default: &83 + default: &81 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13444,7 +13046,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *79 + - *77 - *17 - *19 responses: @@ -13454,11 +13056,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '403': *29 @@ -13478,7 +13080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *79 + - *77 - *17 - *19 responses: @@ -13488,11 +13090,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '401': *25 '304': *37 '403': *29 @@ -13518,7 +13120,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &84 + - &82 name: gist_id description: The unique identifier of the gist. in: path @@ -13530,10 +13132,10 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - default: *83 - '403': &87 + default: *81 + '403': &85 description: Forbidden Gist content: application/json: @@ -13581,7 +13183,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *84 + - *82 requestBody: required: true content: @@ -13641,9 +13243,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - updateGist: *83 + updateGist: *81 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -13801,7 +13403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -13830,7 +13432,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *84 + - *82 - *17 - *19 responses: @@ -13840,7 +13442,7 @@ paths: application/json: schema: type: array - items: &85 + items: &83 title: Gist Comment description: A comment made to a gist. type: object @@ -13875,7 +13477,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *72 + author_association: *71 required: - url - id @@ -13915,7 +13517,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -13940,7 +13542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *84 + - *82 requestBody: required: true content: @@ -13965,9 +13567,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: &86 + default: &84 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14025,8 +13627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *84 - - &88 + - *82 + - &86 name: comment_id description: The unique identifier of the comment. in: path @@ -14039,12 +13641,12 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: *86 + default: *84 '304': *37 '404': *6 - '403': *87 + '403': *85 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14066,8 +13668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *84 - - *88 + - *82 + - *86 requestBody: required: true content: @@ -14092,9 +13694,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: *86 + default: *84 '404': *6 x-github: githubCloudOnly: false @@ -14111,8 +13713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *84 - - *88 + - *82 + - *86 responses: '204': description: Response @@ -14135,7 +13737,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *84 + - *82 - *17 - *19 responses: @@ -14236,7 +13838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *84 + - *82 - *17 - *19 responses: @@ -14246,7 +13848,7 @@ paths: application/json: schema: type: array - items: *82 + items: *80 examples: default: value: @@ -14292,7 +13894,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '404': *6 '304': *37 '403': *29 @@ -14311,13 +13913,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *84 + - *82 responses: '201': description: Response content: application/json: - schema: *80 + schema: *78 examples: default: value: @@ -14388,7 +13990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *84 + - *82 responses: '204': description: Response if gist is starred @@ -14418,7 +14020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -14440,7 +14042,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -14469,7 +14071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *84 + - *82 - name: sha in: path required: true @@ -14480,9 +14082,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - default: *83 + default: *81 '422': *15 '404': *6 '403': *29 @@ -14641,7 +14243,7 @@ paths: type: integer repositories: type: array - items: *67 + items: *66 repository_selection: type: string example: selected @@ -14764,7 +14366,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '403': *29 '304': *37 '401': *25 @@ -14848,7 +14450,7 @@ paths: - closed - all default: open - - &212 + - &219 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -14867,7 +14469,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - name: collab in: query required: false @@ -14897,9 +14499,9 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: &213 + default: &220 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15144,7 +14746,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '404': *6 @@ -15183,8 +14785,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 examples: default: value: @@ -15469,7 +15071,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &89 + X-CommonMarker-Version: &87 example: 0.17.4 schema: type: string @@ -15524,7 +15126,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *89 + X-CommonMarker-Version: *87 content: text/html: schema: @@ -15553,7 +15155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &92 + - &90 name: account_id description: account_id parameter in: path @@ -15565,7 +15167,7 @@ paths: description: Response content: application/json: - schema: &91 + schema: &89 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -15595,7 +15197,7 @@ paths: nullable: true id: type: integer - plan: &90 + plan: &88 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -15684,7 +15286,7 @@ paths: nullable: true updated_at: type: string - plan: *90 + plan: *88 required: - url - id @@ -15692,7 +15294,7 @@ paths: - login - marketplace_purchase examples: - default: &93 + default: &91 value: url: https://api.github.com/orgs/github type: Organization @@ -15777,9 +15379,9 @@ paths: application/json: schema: type: array - items: *90 + items: *88 examples: - default: &94 + default: &92 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -15797,7 +15399,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '404': *6 '401': *25 x-github: @@ -15819,14 +15421,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &95 + - &93 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &96 + - &94 name: sort description: The property to sort the results by. in: query @@ -15856,9 +15458,9 @@ paths: application/json: schema: type: array - items: *91 + items: *89 examples: - default: &97 + default: &95 value: - url: https://api.github.com/orgs/github type: Organization @@ -15909,7 +15511,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '404': *6 '422': *15 '401': *25 @@ -15932,15 +15534,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *92 + - *90 responses: '200': description: Response content: application/json: - schema: *91 + schema: *89 examples: - default: *93 + default: *91 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -15972,11 +15574,11 @@ paths: application/json: schema: type: array - items: *90 + items: *88 examples: - default: *94 + default: *92 headers: - Link: *58 + Link: *54 '401': *25 x-github: githubCloudOnly: false @@ -15997,8 +15599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *95 - - *96 + - *93 + - *94 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16018,11 +15620,11 @@ paths: application/json: schema: type: array - items: *91 + items: *89 examples: - default: *97 + default: *95 headers: - Link: *58 + Link: *54 '401': *25 x-github: githubCloudOnly: false @@ -16284,14 +15886,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &330 + - &325 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &331 + - &326 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16308,7 +15910,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -16353,7 +15955,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &339 + '301': &334 description: Moved permanently content: application/json: @@ -16375,7 +15977,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &558 + - &553 name: all description: If `true`, show notifications marked as read. in: query @@ -16383,7 +15985,7 @@ paths: schema: type: boolean default: false - - &559 + - &554 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16392,8 +15994,8 @@ paths: schema: type: boolean default: false - - *79 - - &560 + - *77 + - &555 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -16418,18 +16020,18 @@ paths: application/json: schema: type: array - items: &99 + items: &97 title: Thread description: Thread type: object properties: id: type: string - repository: &137 + repository: &142 title: Minimal Repository description: Minimal Repository type: object - properties: &182 + properties: &189 id: type: integer format: int64 @@ -16705,7 +16307,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &265 + security_and_analysis: &270 nullable: true type: object properties: @@ -16779,7 +16381,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &183 + required: &190 - archive_url - assignees_url - blobs_url @@ -16867,7 +16469,7 @@ paths: - url - subscription_url examples: - default: &561 + default: &556 value: - id: '1' repository: @@ -16949,7 +16551,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -17033,7 +16635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &100 + - &98 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -17047,7 +16649,7 @@ paths: description: Response content: application/json: - schema: *99 + schema: *97 examples: default: value: @@ -17149,7 +16751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *100 + - *98 responses: '205': description: Reset Content @@ -17171,7 +16773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *100 + - *98 responses: '204': description: No content @@ -17194,13 +16796,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *100 + - *98 responses: '200': description: Response content: application/json: - schema: &101 + schema: &99 title: Thread Subscription description: Thread Subscription type: object @@ -17237,7 +16839,7 @@ paths: - url - subscribed examples: - default: &102 + default: &100 value: subscribed: true ignored: false @@ -17268,7 +16870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *100 + - *98 requestBody: required: false content: @@ -17289,9 +16891,9 @@ paths: description: Response content: application/json: - schema: *101 + schema: *99 examples: - default: *102 + default: *100 '304': *37 '403': *29 '401': *25 @@ -17314,7 +16916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *100 + - *98 responses: '204': description: Response @@ -17409,79 +17011,9 @@ paths: application/json: schema: type: array - items: &218 - title: Organization Simple - description: A GitHub organization. - type: object - properties: &167 - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: &168 - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description + items: *61 examples: - default: &672 - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default: *101 headers: Link: example: ; rel="next" @@ -17508,13 +17040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - &105 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *63 - name: page in: query description: The page number of results to fetch. @@ -17558,8 +17084,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *103 - required: *104 + properties: *102 + required: *103 nullable: true additionalProperties: false examples: @@ -17665,7 +17191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -17731,7 +17257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *105 + - *63 requestBody: required: true content: @@ -17764,12 +17290,131 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &104 + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + examples: + default: &562 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - *63 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: *104 + required: + - properties + examples: + default: &563 + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -17777,7 +17422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *105 + - *63 - &107 name: year description: If specified, only return results for a single year. The value @@ -17787,7 +17432,7 @@ paths: required: false schema: type: integer - - &698 + - &702 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -17811,14 +17456,14 @@ paths: required: false schema: type: string - - &699 + - &703 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &700 + - &704 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -17880,19 +17525,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -17934,8 +17579,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17955,9 +17600,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *105 + - *63 - *107 - - &703 + - &707 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -17967,7 +17612,7 @@ paths: schema: type: integer - *108 - - &704 + - &708 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -18050,8 +17695,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18077,7 +17722,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -18502,7 +18147,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *105 + - *63 requestBody: required: false content: @@ -18752,7 +18397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *105 + - *63 responses: '202': *39 '404': *6 @@ -18777,7 +18422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -18803,7 +18448,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18824,7 +18469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -18842,7 +18487,7 @@ paths: type: integer repository_cache_usages: type: array - items: &344 + items: &339 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18877,7 +18522,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18897,7 +18542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -18958,13 +18603,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + example: latest required: - id - size_gb - display_name - source nullable: true - machine_size_details: &116 + machine_size_details: &121 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -19047,6 +18697,10 @@ paths: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -19056,7 +18710,7 @@ paths: - public_ip_enabled - platform examples: - default: &136 + default: &141 value: total_count: 2 runners: @@ -19098,7 +18752,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19116,7 +18770,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -19145,6 +18799,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -19162,6 +18821,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -19185,7 +18849,7 @@ paths: application/json: schema: *113 examples: - default: &117 + default: &122 value: id: 5 name: My hosted ubuntu runner @@ -19212,6 +18876,307 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &114 + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` + parameter when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the + image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &116 + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *63 + - &115 + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *114 + examples: + default: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - *63 + - *115 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - *115 + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: &117 + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image + version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *116 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - *63 + - *115 + - &118 + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" + responses: + '200': + description: Response + content: + application/json: + schema: *117 + examples: + default: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - *63 + - *115 + - *118 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -19224,7 +19189,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19240,7 +19205,7 @@ paths: type: integer images: type: array - items: &114 + items: &119 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -19276,7 +19241,7 @@ paths: - display_name - source examples: - default: &115 + default: &120 value: id: ubuntu-20.04 platform: linux-x64 @@ -19300,7 +19265,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19316,9 +19281,9 @@ paths: type: integer images: type: array - items: *114 + items: *119 examples: - default: *115 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19335,7 +19300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19388,7 +19353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19404,7 +19369,7 @@ paths: type: integer machine_specs: type: array - items: *116 + items: *121 examples: default: value: @@ -19429,7 +19394,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19473,8 +19438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *105 - - &118 + - *63 + - &123 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19488,9 +19453,9 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19508,8 +19473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *105 - - *118 + - *63 + - *123 requestBody: required: true content: @@ -19535,6 +19500,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -19549,7 +19519,7 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19565,8 +19535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *105 - - *118 + - *63 + - *123 responses: '202': description: Response @@ -19574,7 +19544,7 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19594,13 +19564,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *105 + - *63 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &119 + schema: &124 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19614,7 +19584,7 @@ paths: required: - include_claim_keys examples: - default: &120 + default: &125 value: include_claim_keys: - repo @@ -19636,20 +19606,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: *119 + schema: *124 examples: - default: *120 + default: *125 responses: '201': description: Empty response content: application/json: - schema: &146 + schema: &151 title: Empty Object description: An object without any properties. type: object @@ -19679,7 +19649,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19688,7 +19658,7 @@ paths: schema: type: object properties: - enabled_repositories: &121 + enabled_repositories: &126 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19701,7 +19671,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &122 + allowed_actions: &127 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19709,12 +19679,12 @@ paths: - all - local_only - selected - selected_actions_url: &350 + selected_actions_url: &345 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &123 + sha_pinning_required: &128 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19745,7 +19715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -19756,9 +19726,9 @@ paths: schema: type: object properties: - enabled_repositories: *121 - allowed_actions: *122 - sha_pinning_required: *123 + enabled_repositories: *126 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled_repositories examples: @@ -19786,13 +19756,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &354 + schema: &349 type: object properties: days: @@ -19829,12 +19799,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &355 + schema: &350 type: object properties: days: @@ -19871,13 +19841,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &124 + schema: &129 type: object properties: approval_policy: @@ -19891,7 +19861,7 @@ paths: required: - approval_policy examples: - default: &356 + default: &351 value: approval_policy: first_time_contributors '404': *6 @@ -19912,7 +19882,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -19922,7 +19892,7 @@ paths: required: true content: application/json: - schema: *124 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -19944,13 +19914,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &357 + schema: &352 type: object required: - run_workflows_from_fork_pull_requests @@ -19976,7 +19946,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &125 + default: &130 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19999,12 +19969,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &358 + schema: &353 type: object required: - run_workflows_from_fork_pull_requests @@ -20027,7 +19997,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *125 + default: *130 responses: '204': description: Empty response for successful settings update @@ -20057,7 +20027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -20075,9 +20045,9 @@ paths: type: number repositories: type: array - items: *67 + items: *66 examples: - default: &129 + default: &134 value: total_count: 1 repositories: @@ -20217,7 +20187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -20261,8 +20231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *105 - - &126 + - *63 + - &131 name: repository_id description: The unique identifier of the repository. in: path @@ -20290,8 +20260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -20314,13 +20284,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &127 + schema: &132 type: object properties: github_owned_allowed: @@ -20342,7 +20312,7 @@ paths: items: type: string examples: - default: &128 + default: &133 value: github_owned_allowed: true verified_allowed: false @@ -20367,7 +20337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -20375,9 +20345,9 @@ paths: required: false content: application/json: - schema: *127 + schema: *132 examples: - selected_actions: *128 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20397,7 +20367,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -20445,7 +20415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20492,7 +20462,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -20507,9 +20477,9 @@ paths: type: integer repositories: type: array - items: *67 + items: *66 examples: - default: *129 + default: *134 '403': *29 '404': *6 x-github: @@ -20529,7 +20499,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20577,8 +20547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: No content @@ -20604,8 +20574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: No content @@ -20633,23 +20603,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &359 + schema: &354 type: object properties: - default_workflow_permissions: &130 + default_workflow_permissions: &135 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &131 + can_approve_pull_request_reviews: &136 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20657,7 +20627,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &132 + default: &137 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20682,7 +20652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Success response @@ -20690,13 +20660,13 @@ paths: required: false content: application/json: - schema: &360 + schema: &355 type: object properties: - default_workflow_permissions: *130 - can_approve_pull_request_reviews: *131 + default_workflow_permissions: *135 + can_approve_pull_request_reviews: *136 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20716,7 +20686,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *105 + - *63 - *17 - *19 - name: visible_to_repository @@ -20741,7 +20711,7 @@ paths: type: number runner_groups: type: array - items: &133 + items: &138 type: object properties: id: @@ -20857,7 +20827,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20929,9 +20899,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: - default: &135 + default: &140 value: id: 2 name: octo-runner-group @@ -20966,8 +20936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *105 - - &134 + - *63 + - &139 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20979,7 +20949,7 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: default: value: @@ -21015,8 +20985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21070,9 +21040,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: - default: *135 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21091,8 +21061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *105 - - *134 + - *63 + - *139 responses: '204': description: Response @@ -21115,8 +21085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *17 - *19 responses: @@ -21136,9 +21106,9 @@ paths: type: array items: *113 examples: - default: *136 + default: *141 headers: - Link: *58 + Link: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21158,8 +21128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *19 - *17 responses: @@ -21177,9 +21147,9 @@ paths: type: number repositories: type: array - items: *137 + items: *142 examples: - default: &658 + default: &663 value: total_count: 1 repositories: @@ -21431,8 +21401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21476,9 +21446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 - - *126 + - *63 + - *139 + - *131 responses: '204': description: Response @@ -21500,9 +21470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 - - *126 + - *63 + - *139 + - *131 responses: '204': description: Response @@ -21525,8 +21495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *17 - *19 responses: @@ -21544,7 +21514,7 @@ paths: type: number runners: type: array - items: &139 + items: &144 title: Self hosted runners description: A self hosted runner type: object @@ -21573,7 +21543,7 @@ paths: type: boolean labels: type: array - items: &142 + items: &147 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21603,7 +21573,7 @@ paths: - busy - labels examples: - default: &140 + default: &145 value: total_count: 2 runners: @@ -21643,7 +21613,7 @@ paths: name: no-gpu type: custom headers: - Link: *58 + Link: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21662,8 +21632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21707,9 +21677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *105 - - *134 - - &138 + - *63 + - *139 + - &143 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21737,9 +21707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *105 - - *134 - - *138 + - *63 + - *139 + - *143 responses: '204': description: Response @@ -21769,7 +21739,7 @@ paths: in: query schema: type: string - - *105 + - *63 - *17 - *19 responses: @@ -21787,11 +21757,11 @@ paths: type: integer runners: type: array - items: *139 + items: *144 examples: - default: *140 + default: *145 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21813,7 +21783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -21821,7 +21791,7 @@ paths: application/json: schema: type: array - items: &361 + items: &356 title: Runner Application description: Runner Application type: object @@ -21846,7 +21816,7 @@ paths: - download_url - filename examples: - default: &362 + default: &357 value: - os: osx architecture: x64 @@ -21889,7 +21859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -21932,7 +21902,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &363 + '201': &358 description: Response content: application/json: @@ -21942,7 +21912,7 @@ paths: - runner - encoded_jit_config properties: - runner: *139 + runner: *144 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21999,13 +21969,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *105 + - *63 responses: '201': description: Response content: application/json: - schema: &141 + schema: &146 title: Authentication Token description: Authentication Token type: object @@ -22027,7 +21997,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *67 + items: *66 single_file: type: string example: config.yaml @@ -22043,7 +22013,7 @@ paths: - token - expires_at examples: - default: &364 + default: &359 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22074,15 +22044,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *105 + - *63 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: &365 + default: &360 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22107,16 +22077,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: '200': description: Response content: application/json: - schema: *139 + schema: *144 examples: - default: &366 + default: &361 value: id: 23 name: MBP @@ -22157,8 +22127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: '204': description: Response @@ -22184,10 +22154,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: - '200': &143 + '200': &148 description: Response content: application/json: @@ -22201,7 +22171,7 @@ paths: type: integer labels: type: array - items: *142 + items: *147 examples: default: value: @@ -22240,8 +22210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 requestBody: required: true content: @@ -22265,7 +22235,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22289,8 +22259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 requestBody: required: true content: @@ -22315,7 +22285,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22339,10 +22309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: - '200': &367 + '200': &362 description: Response content: application/json: @@ -22356,7 +22326,7 @@ paths: type: integer labels: type: array - items: *142 + items: *147 examples: default: value: @@ -22397,9 +22367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 - - &368 + - *63 + - *143 + - &363 name: name description: The name of a self-hosted runner's custom label. in: path @@ -22407,7 +22377,7 @@ paths: schema: type: string responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22432,7 +22402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -22450,7 +22420,7 @@ paths: type: integer secrets: type: array - items: &144 + items: &149 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22500,7 +22470,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22523,13 +22493,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &380 + schema: &375 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22558,7 +22528,7 @@ paths: - key_id - key examples: - default: &381 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22583,8 +22553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *105 - - &145 + - *63 + - &150 name: secret_name description: The name of the secret. in: path @@ -22596,7 +22566,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *149 examples: default: value: @@ -22626,8 +22596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -22684,7 +22654,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -22710,8 +22680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -22737,8 +22707,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -22756,9 +22726,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: &149 + default: &154 value: total_count: 1 repositories: @@ -22850,8 +22820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -22903,8 +22873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -22937,8 +22907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -22970,8 +22940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *105 - - &349 + - *63 + - &344 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -22995,7 +22965,7 @@ paths: type: integer variables: type: array - items: &147 + items: &152 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23059,7 +23029,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23080,7 +23050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *105 + - *63 requestBody: required: true content: @@ -23128,7 +23098,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -23153,8 +23123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *105 - - &148 + - *63 + - &153 name: name description: The name of the variable. in: path @@ -23166,7 +23136,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *152 examples: default: value: @@ -23196,8 +23166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 requestBody: required: true content: @@ -23259,8 +23229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 responses: '204': description: Response @@ -23286,8 +23256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - *19 - *17 responses: @@ -23305,9 +23275,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23333,8 +23303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 requestBody: required: true content: @@ -23383,8 +23353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - name: repository_id in: path required: true @@ -23418,8 +23388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - name: repository_id in: path required: true @@ -23450,7 +23420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *105 + - *63 requestBody: required: true content: @@ -23582,7 +23552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *105 + - *63 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23667,7 +23637,7 @@ paths: - *17 - *40 - *41 - - *105 + - *63 requestBody: required: true content: @@ -23690,12 +23660,12 @@ paths: required: - subject_digests examples: - default: &687 + default: &691 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &688 + withPredicateType: &692 value: subject_digests: - sha256:abc123 @@ -23753,7 +23723,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &689 + default: &693 value: attestations_subject_digests: - sha256:abc: @@ -23862,7 +23832,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *105 + - *63 requestBody: required: true content: @@ -23927,7 +23897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *105 + - *63 - name: subject_digest description: Subject Digest in: path @@ -23946,6 +23916,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - *17 + - *40 + - *41 + - *63 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -23958,7 +23979,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *105 + - *63 - name: attestation_id description: Attestation ID in: path @@ -23996,7 +24017,7 @@ paths: - *17 - *40 - *41 - - *105 + - *63 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24049,7 +24070,7 @@ paths: initiator: type: string examples: - default: &394 + default: &389 value: attestations: - bundle: @@ -24156,7 +24177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -24168,7 +24189,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24187,8 +24208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: If the user is blocked @@ -24213,8 +24234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -24234,8 +24255,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -24260,7 +24281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *105 + - *63 - *19 - *17 - *48 @@ -24268,7 +24289,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &150 + schema: &155 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24294,7 +24315,7 @@ paths: application/json: schema: type: array - items: &151 + items: &156 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24325,7 +24346,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &169 + items: &178 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24400,7 +24421,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &225 + properties: &231 id: description: Unique identifier of the team type: integer @@ -24472,7 +24493,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &226 + required: &232 - id - node_id - url @@ -24515,7 +24536,7 @@ paths: type: string format: date-time nullable: true - state: *150 + state: *155 contact_link: description: The contact link of the campaign. type: string @@ -24610,9 +24631,9 @@ paths: closed_at: state: open headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24636,7 +24657,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -24700,6 +24721,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -24709,7 +24731,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -24730,9 +24756,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: &152 + default: &157 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24781,7 +24807,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24803,7 +24829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24815,16 +24841,16 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: *152 + default: *157 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24845,7 +24871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24894,7 +24920,7 @@ paths: type: string format: uri nullable: true - state: *150 + state: *155 examples: default: value: @@ -24904,9 +24930,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: *152 + default: *157 '400': description: Bad Request content: @@ -24918,7 +24944,7 @@ paths: content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24939,7 +24965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24950,7 +24976,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24972,18 +24998,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *105 - - &419 + - *63 + - &414 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &156 + schema: &165 type: string description: The name of the tool used to generate the code scanning analysis. - - &420 + - &415 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -24991,7 +25017,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &157 + schema: &166 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -25006,7 +25032,7 @@ paths: be returned. in: query required: false - schema: &422 + schema: &417 type: string description: State of a code scanning alert. enum: @@ -25029,7 +25055,7 @@ paths: be returned. in: query required: false - schema: &423 + schema: &418 type: string description: Severity of a code scanning alert. enum: @@ -25050,18 +25076,18 @@ paths: items: type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: &424 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: &419 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &158 + state: &167 type: string description: State of a code scanning alert. nullable: true @@ -25069,7 +25095,7 @@ paths: - open - dismissed - fixed - fixed_at: *154 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -25077,8 +25103,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: &425 + dismissed_at: *164 + dismissed_reason: &420 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -25087,13 +25113,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &426 + dismissed_comment: &421 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &427 + rule: &422 type: object properties: id: @@ -25146,25 +25172,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &428 + tool: &423 type: object properties: - name: *156 + name: *165 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *157 - most_recent_instance: &429 + guid: *166 + most_recent_instance: &424 type: object properties: - ref: &421 + ref: &416 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &439 + analysis_key: &434 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25175,13 +25201,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &440 + category: &435 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *158 + state: *167 commit_sha: type: string message: @@ -25475,9 +25501,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25499,7 +25525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *105 + - *63 - name: target_type in: query description: The target type of the code security configuration @@ -25610,7 +25636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *105 + - *63 requestBody: required: true content: @@ -25688,7 +25714,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *159 + code_scanning_options: *168 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25831,7 +25857,7 @@ paths: application/json: schema: *43 examples: - default: *160 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25853,15 +25879,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *161 + schema: *170 examples: - default: *162 + default: *171 '304': *37 '403': *29 '404': *6 @@ -25887,7 +25913,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *105 + - *63 requestBody: required: true content: @@ -25913,7 +25939,7 @@ paths: - 32 - 91 responses: - '204': *163 + '204': *172 '400': *14 '403': *29 '404': *6 @@ -25939,7 +25965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *105 + - *63 - *45 responses: '200': @@ -25948,7 +25974,7 @@ paths: application/json: schema: *43 examples: - default: *160 + default: *169 '304': *37 '403': *29 '404': *6 @@ -25972,7 +25998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26229,10 +26255,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *105 + - *63 - *45 responses: - '204': *163 + '204': *172 '400': *14 '403': *29 '404': *6 @@ -26260,7 +26286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26324,7 +26350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26370,7 +26396,7 @@ paths: default: value: default_for_new_repos: all - configuration: *160 + configuration: *169 '403': *29 '404': *6 x-github: @@ -26394,7 +26420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *105 + - *63 - *45 - name: per_page description: The number of results per page (max 100). For more information, @@ -26423,13 +26449,13 @@ paths: application/json: schema: type: array - items: *164 + items: *173 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *165 + repository: *174 '403': *29 '404': *6 x-github: @@ -26453,7 +26479,7 @@ paths: parameters: - *17 - *19 - - *105 + - *63 responses: '200': description: Response @@ -26469,7 +26495,7 @@ paths: type: integer codespaces: type: array - items: &214 + items: &221 type: object title: Codespace description: A codespace. @@ -26494,12 +26520,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *137 + repository: *142 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &452 + properties: &447 name: type: string description: The name of the machine. @@ -26541,7 +26567,7 @@ paths: - ready - in_progress nullable: true - required: &453 + required: &448 - name - display_name - operating_system @@ -26746,7 +26772,7 @@ paths: - pulls_url - recent_folders examples: - default: &215 + default: &222 value: total_count: 3 codespaces: @@ -27156,7 +27182,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -27178,7 +27204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *105 + - *63 deprecated: true requestBody: required: true @@ -27222,7 +27248,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27245,7 +27271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *105 + - *63 deprecated: true requestBody: required: true @@ -27277,7 +27303,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27300,7 +27326,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *105 + - *63 requestBody: required: true content: @@ -27331,7 +27357,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27352,7 +27378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -27370,7 +27396,7 @@ paths: type: integer secrets: type: array - items: &166 + items: &175 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27409,7 +27435,7 @@ paths: - updated_at - visibility examples: - default: &454 + default: &449 value: total_count: 2 secrets: @@ -27422,7 +27448,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27441,13 +27467,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &455 + schema: &450 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27476,7 +27502,7 @@ paths: - key_id - key examples: - default: &456 + default: &451 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27499,23 +27525,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: Response content: application/json: - schema: *166 + schema: *175 examples: - default: &458 + default: &453 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27535,8 +27561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -27591,7 +27617,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -27617,8 +27643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -27643,8 +27669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -27662,9 +27688,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 '404': *6 x-github: githubCloudOnly: false @@ -27686,8 +27712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -27737,8 +27763,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -27771,8 +27797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -27811,7 +27837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: OK @@ -27920,7 +27946,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -27952,7 +27978,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *105 + - *63 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -27975,7 +28001,7 @@ paths: currently being billed. seats: type: array - items: &217 + items: &224 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27992,15 +28018,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *167 - required: *168 + properties: *176 + required: *177 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *169 - - *59 + - *178 + - *55 nullable: true pending_cancellation_date: type: string @@ -28124,8 +28150,8 @@ paths: type: User site_admin: false headers: - Link: *58 - '500': *106 + Link: *54 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28158,7 +28184,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28200,7 +28226,7 @@ paths: default: value: seats_created: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28236,7 +28262,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28278,7 +28304,7 @@ paths: default: value: seats_cancelled: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28316,7 +28342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28357,7 +28383,7 @@ paths: default: value: seats_created: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28393,7 +28419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28435,7 +28461,7 @@ paths: default: value: seats_cancelled: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28474,7 +28500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *105 + - *63 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -28506,7 +28532,7 @@ paths: application/json: schema: type: array - items: &312 + items: &307 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -28813,7 +28839,7 @@ paths: - date additionalProperties: true examples: - default: &313 + default: &308 value: - date: '2024-06-24' total_active_users: 24 @@ -28912,10 +28938,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *106 + '500': *105 '403': *29 '404': *6 - '422': &314 + '422': &309 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -28942,12 +28968,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *105 - - *170 - - *171 - - *172 - - *173 - - *174 + - *63 + - *179 + - *180 + - *181 + - *182 + - *183 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28985,13 +29011,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *175 - - *176 + - *184 + - *185 - *48 - *40 - *41 - - *177 - - *178 - *17 responses: '200': @@ -29000,9 +29024,9 @@ paths: application/json: schema: type: array - items: *179 + items: *186 examples: - default: *180 + default: *187 '304': *37 '400': *14 '403': *29 @@ -29028,7 +29052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29046,7 +29070,7 @@ paths: type: integer secrets: type: array - items: &181 + items: &188 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29096,7 +29120,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29117,13 +29141,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &484 + schema: &479 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29140,7 +29164,7 @@ paths: - key_id - key examples: - default: &485 + default: &480 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29163,14 +29187,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: Response content: application/json: - schema: *181 + schema: *188 examples: default: value: @@ -29198,8 +29222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -29258,7 +29282,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -29282,8 +29306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -29307,8 +29331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -29326,9 +29350,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29349,8 +29373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -29400,8 +29424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -29432,8 +29456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -29463,7 +29487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -29471,7 +29495,7 @@ paths: application/json: schema: type: array - items: &228 + items: &234 title: Package description: A software package type: object @@ -29521,8 +29545,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *182 - required: *183 + properties: *189 + required: *190 nullable: true created_at: type: string @@ -29541,7 +29565,7 @@ paths: - created_at - updated_at examples: - default: &229 + default: &235 value: - id: 197 name: hello_docker @@ -29619,7 +29643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29629,7 +29653,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: 200-response: value: @@ -29701,7 +29725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29711,7 +29735,7 @@ paths: application/json: schema: type: array - items: &206 + items: &213 title: Organization Invitation description: Organization Invitation type: object @@ -29758,7 +29782,7 @@ paths: - invitation_teams_url - node_id examples: - default: &207 + default: &214 value: - id: 1 login: monalisa @@ -29791,7 +29815,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -29815,7 +29839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29825,7 +29849,7 @@ paths: application/json: schema: type: array - items: &184 + items: &191 title: Org Hook description: Org Hook type: object @@ -29913,7 +29937,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -29936,7 +29960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *105 + - *63 requestBody: required: true content: @@ -29996,9 +30020,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: - default: &185 + default: &192 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30045,8 +30069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *105 - - &186 + - *63 + - &193 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -30059,9 +30083,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: - default: *185 + default: *192 '404': *6 x-github: githubCloudOnly: false @@ -30088,8 +30112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 requestBody: required: false content: @@ -30134,7 +30158,7 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: default: value: @@ -30175,8 +30199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 responses: '204': description: Response @@ -30203,8 +30227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *105 - - *186 + - *63 + - *193 responses: '200': description: Response @@ -30234,8 +30258,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *105 - - *186 + - *63 + - *193 requestBody: required: false content: @@ -30285,10 +30309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *17 - - *187 + - *194 responses: '200': description: Response @@ -30296,9 +30320,9 @@ paths: application/json: schema: type: array - items: *188 + items: *195 examples: - default: *189 + default: *196 '400': *14 '422': *15 x-github: @@ -30323,17 +30347,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *197 examples: - default: *191 + default: *198 '400': *14 '422': *15 x-github: @@ -30358,8 +30382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *16 responses: '202': *39 @@ -30388,8 +30412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 responses: '204': description: Response @@ -30411,8 +30435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *105 - - &196 + - *63 + - &203 name: actor_type in: path description: The type of the actor @@ -30425,14 +30449,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &197 + - &204 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &192 + - &199 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -30440,7 +30464,7 @@ paths: required: true schema: type: string - - &193 + - &200 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -30533,13 +30557,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *105 - - *192 - - *193 + - *63 + - *199 + - *200 - *19 - *17 - *48 - - &202 + - &209 name: sort description: The property to sort the results by. in: query @@ -30617,15 +30641,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *105 - - *192 - - *193 + - *63 + - *199 + - *200 responses: '200': description: Response content: application/json: - schema: &194 + schema: &201 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30641,7 +30665,7 @@ paths: type: integer format: int64 examples: - default: &195 + default: &202 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30661,24 +30685,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *105 - - &198 + - *63 + - &205 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *192 - - *193 + - *199 + - *200 responses: '200': description: Response content: application/json: - schema: *194 + schema: *201 examples: - default: *195 + default: *202 x-github: enabledForGitHubApps: true category: orgs @@ -30696,19 +30720,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *105 - - *192 - - *193 - - *196 - - *197 + - *63 + - *199 + - *200 + - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *194 + schema: *201 examples: - default: *195 + default: *202 x-github: enabledForGitHubApps: true category: orgs @@ -30725,10 +30749,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *105 - - *192 - - *193 - - &199 + - *63 + - *199 + - *200 + - &206 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30741,7 +30765,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &207 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30757,7 +30781,7 @@ paths: type: integer format: int64 examples: - default: &201 + default: &208 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30793,19 +30817,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *105 - - *198 - - *192 - - *193 + - *63 + - *205 - *199 + - *200 + - *206 responses: '200': description: Response content: application/json: - schema: *200 + schema: *207 examples: - default: *201 + default: *208 x-github: enabledForGitHubApps: true category: orgs @@ -30822,20 +30846,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *105 - - *196 - - *197 - - *192 - - *193 + - *63 + - *203 + - *204 - *199 + - *200 + - *206 responses: '200': description: Response content: application/json: - schema: *200 + schema: *207 examples: - default: *201 + default: *208 x-github: enabledForGitHubApps: true category: orgs @@ -30852,14 +30876,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *105 - - *198 - - *192 - - *193 + - *63 + - *205 + - *199 + - *200 - *19 - *17 - *48 - - *202 + - *209 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30932,7 +30956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *105 + - *63 responses: '200': description: Response @@ -30940,7 +30964,7 @@ paths: application/json: schema: *22 examples: - default: &523 + default: &518 value: id: 1 account: @@ -31009,7 +31033,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -31079,7 +31103,7 @@ paths: suspended_at: suspended_by: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31098,7 +31122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -31106,12 +31130,12 @@ paths: application/json: schema: anyOf: - - &204 + - &211 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &203 + limit: &210 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31136,7 +31160,7 @@ paths: properties: {} additionalProperties: false examples: - default: &205 + default: &212 value: limit: collaborators_only origin: organization @@ -31160,18 +31184,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &524 + schema: &519 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *203 + limit: *210 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31195,9 +31219,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: - default: *205 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -31215,7 +31239,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -31239,7 +31263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *105 + - *63 - *17 - *19 - name: role @@ -31273,11 +31297,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31298,7 +31322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *105 + - *63 requestBody: required: false content: @@ -31352,7 +31376,7 @@ paths: description: Response content: application/json: - schema: *206 + schema: *213 examples: default: value: @@ -31406,8 +31430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *105 - - &208 + - *63 + - &215 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31437,8 +31461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *105 - - *208 + - *63 + - *215 - *17 - *19 responses: @@ -31448,9 +31472,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: &227 + default: &233 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31466,7 +31490,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31485,7 +31509,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -31493,7 +31517,7 @@ paths: application/json: schema: type: array - items: *209 + items: *216 examples: default: value: @@ -31531,7 +31555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -31578,9 +31602,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *216 examples: - default: &210 + default: &217 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31612,8 +31636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *105 - - &211 + - *63 + - &218 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31666,9 +31690,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *216 examples: - default: *210 + default: *217 '404': *6 '422': *7 x-github: @@ -31692,8 +31716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *105 - - *211 + - *63 + - *218 responses: '204': description: Response @@ -31726,7 +31750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *105 + - *63 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31756,7 +31780,7 @@ paths: - closed - all default: open - - *212 + - *219 - name: type description: Can be the name of an issue type. in: query @@ -31775,7 +31799,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -31785,11 +31809,11 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *213 + default: *220 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31809,7 +31833,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *105 + - *63 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31847,9 +31871,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -31867,8 +31891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response if requester is an organization member and user is @@ -31902,8 +31926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -31929,8 +31953,8 @@ paths: parameters: - *17 - *19 - - *105 - *63 + - *59 responses: '200': description: Response @@ -31946,11 +31970,11 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: - default: *215 + default: *222 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -31973,9 +31997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *105 - *63 - - &216 + - *59 + - &223 name: codespace_name in: path required: true @@ -31985,7 +32009,7 @@ paths: responses: '202': *39 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32008,17 +32032,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *105 - *63 - - *216 + - *59 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: &451 + default: &446 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32160,7 +32184,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32191,14 +32215,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *105 - *63 + - *59 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *217 + schema: *224 examples: default: value: @@ -32242,7 +32266,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32267,14 +32291,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '200': description: Response content: application/json: - schema: &219 + schema: &225 title: Org Membership description: Org Membership type: object @@ -32318,7 +32342,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *218 + organization: *61 user: title: Simple User description: A GitHub user. @@ -32341,7 +32365,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &220 + response-if-user-has-an-active-admin-membership-with-organization: &226 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32409,8 +32433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 requestBody: required: false content: @@ -32438,9 +32462,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - response-if-user-already-had-membership-with-organization: *220 + response-if-user-already-had-membership-with-organization: *226 '422': *15 '403': *29 x-github: @@ -32464,8 +32488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -32490,7 +32514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *105 + - *63 - *17 - *19 - name: exclude @@ -32511,7 +32535,7 @@ paths: application/json: schema: type: array - items: &221 + items: &227 title: Migration description: A migration. type: object @@ -32552,7 +32576,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *67 + items: *66 url: type: string format: uri @@ -32748,7 +32772,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32764,7 +32788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *105 + - *63 requestBody: required: true content: @@ -32840,7 +32864,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -33018,8 +33042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *105 - - &222 + - *63 + - &228 name: migration_id description: The unique identifier of the migration. in: path @@ -33046,7 +33070,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -33215,8 +33239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *105 - - *222 + - *63 + - *228 responses: '302': description: Response @@ -33237,8 +33261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *105 - - *222 + - *63 + - *228 responses: '204': description: Response @@ -33261,9 +33285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *105 - - *222 - - &671 + - *63 + - *228 + - &676 name: repo_name description: repo_name parameter in: path @@ -33290,8 +33314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *105 - - *222 + - *63 + - *228 - *17 - *19 responses: @@ -33301,9 +33325,9 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: &234 + default: &240 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33414,7 +33438,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -33440,7 +33464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response - list of organization roles @@ -33456,7 +33480,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &224 + items: &230 title: Organization Role description: Organization roles type: object @@ -33603,8 +33627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -33629,9 +33653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *105 - - *65 - - &223 + - *63 + - *64 + - &229 name: role_id description: The unique identifier of the role. in: path @@ -33666,9 +33690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *105 - - *65 - - *223 + - *63 + - *64 + - *229 responses: '204': description: Response @@ -33693,8 +33717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -33719,9 +33743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *105 - *63 - - *223 + - *59 + - *229 responses: '204': description: Response @@ -33751,9 +33775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *105 - *63 - - *223 + - *59 + - *229 responses: '204': description: Response @@ -33781,14 +33805,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: default: value: @@ -33838,8 +33862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 - *17 - *19 responses: @@ -33917,8 +33941,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 nullable: true type: description: The ownership type of the team @@ -33950,9 +33974,9 @@ paths: - type - parent examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '404': description: Response if the organization or role does not exist. '422': @@ -33979,8 +34003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 - *17 - *19 responses: @@ -34008,13 +34032,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &308 + items: &303 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 name: nullable: true type: string @@ -34109,9 +34133,9 @@ paths: - type - url examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': description: Response if the organization or role does not exist. '422': @@ -34133,7 +34157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *105 + - *63 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -34160,9 +34184,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34185,8 +34209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *105 - *63 + - *59 requestBody: required: false content: @@ -34243,8 +34267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -34301,8 +34325,8 @@ paths: - docker - nuget - container - - *105 - - &673 + - *63 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34338,12 +34362,12 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *229 + default: *235 '403': *29 '401': *25 - '400': &675 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34365,7 +34389,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &230 + - &236 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -34383,20 +34407,20 @@ paths: - docker - nuget - container - - &231 + - &237 name: package_name description: The name of the package. in: path required: true schema: type: string - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -34448,9 +34472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 responses: '204': description: Response @@ -34482,9 +34506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 - name: token description: package token schema: @@ -34516,9 +34540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 - *19 - *17 - name: state @@ -34538,7 +34562,7 @@ paths: application/json: schema: type: array - items: &232 + items: &238 title: Package Version description: A version of a software package type: object @@ -34663,10 +34687,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - &233 + - *236 + - *237 + - *63 + - &239 name: package_version_id description: Unique identifier of the package version. in: path @@ -34678,7 +34702,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -34714,10 +34738,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - *233 + - *236 + - *237 + - *63 + - *239 responses: '204': description: Response @@ -34749,10 +34773,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - *233 + - *236 + - *237 + - *63 + - *239 responses: '204': description: Response @@ -34779,10 +34803,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *105 + - *63 - *17 - *19 - - &235 + - &241 name: sort description: The property by which to sort the results. in: query @@ -34793,7 +34817,7 @@ paths: - created_at default: created_at - *48 - - &236 + - &242 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34804,7 +34828,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &237 + - &243 name: repository description: The name of the repository to use to filter the results. in: query @@ -34812,7 +34836,7 @@ paths: schema: type: string example: Hello-World - - &238 + - &244 name: permission description: The permission to use to filter the results. in: query @@ -34820,7 +34844,7 @@ paths: schema: type: string example: issues_read - - &239 + - &245 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34830,7 +34854,7 @@ paths: schema: type: string format: date-time - - &240 + - &246 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34840,7 +34864,7 @@ paths: schema: type: string format: date-time - - &241 + - &247 name: token_id description: The ID of the token in: query @@ -34852,7 +34876,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -34984,7 +35008,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35004,7 +35028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *105 + - *63 requestBody: required: true content: @@ -35045,7 +35069,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -35070,7 +35094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *105 + - *63 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35106,11 +35130,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35131,7 +35155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *105 + - *63 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35142,7 +35166,7 @@ paths: - *17 - *19 responses: - '500': *106 + '500': *105 '404': *6 '403': *29 '200': @@ -35151,11 +35175,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35176,19 +35200,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *105 + - *63 - *17 - *19 - - *235 - - *48 - - *236 - - *237 - - *238 - - *239 - - *240 - *241 + - *48 + - *242 + - *243 + - *244 + - *245 + - *246 + - *247 responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -35315,7 +35339,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35335,7 +35359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *105 + - *63 requestBody: required: true content: @@ -35370,7 +35394,7 @@ paths: - 1296269 - 1296280 responses: - '500': *106 + '500': *105 '404': *6 '202': *39 '403': *29 @@ -35395,7 +35419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *105 + - *63 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35423,9 +35447,9 @@ paths: value: action: revoke responses: - '500': *106 + '500': *105 '404': *6 - '204': *163 + '204': *172 '403': *29 '422': *15 x-github: @@ -35447,7 +35471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *105 + - *63 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35457,7 +35481,7 @@ paths: - *17 - *19 responses: - '500': *106 + '500': *105 '404': *6 '403': *29 '200': @@ -35466,11 +35490,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35492,7 +35516,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -35510,7 +35534,7 @@ paths: type: integer configurations: type: array - items: &242 + items: &248 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35576,7 +35600,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *58 + Link: *54 '400': *14 '404': *6 x-github: @@ -35598,7 +35622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -35763,7 +35787,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &243 + org-private-registry-with-selected-visibility: &249 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35804,7 +35828,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -35830,7 +35854,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -35852,16 +35876,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 '404': *6 x-github: githubCloudOnly: false @@ -35882,8 +35906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -35978,8 +36002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -36004,7 +36028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *105 + - *63 - name: state description: Indicates the state of the projects to return. in: query @@ -36025,7 +36049,7 @@ paths: application/json: schema: type: array - items: &244 + items: &250 title: Project description: Projects are a way to organize columns and cards of work. @@ -36149,7 +36173,7 @@ paths: organization_permission: write private: true headers: - Link: *58 + Link: *54 '422': *7 x-github: githubCloudOnly: false @@ -36172,7 +36196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *105 + - *63 requestBody: required: true content: @@ -36198,7 +36222,7 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: default: value: @@ -36236,7 +36260,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &336 + '410': &331 description: Gone content: application/json: @@ -36262,7 +36286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *105 + - *63 - name: q description: Limit results to projects of the specified type. in: query @@ -36279,7 +36303,7 @@ paths: application/json: schema: type: array - items: &245 + items: &251 title: Projects v2 Project description: A projects v2 project type: object @@ -36349,7 +36373,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &755 + properties: &759 id: type: number description: The unique identifier of the status update. @@ -36397,7 +36421,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &756 + required: &760 - id - node_id - created_at @@ -36422,7 +36446,7 @@ paths: - deleted_at - deleted_by examples: - default: &246 + default: &252 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -36505,7 +36529,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36525,24 +36549,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &247 + - &253 name: project_number description: The project's number. in: path required: true schema: type: integer - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36562,8 +36586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *247 - - *105 + - *253 + - *63 - *17 - *40 - *41 @@ -36574,7 +36598,7 @@ paths: application/json: schema: type: array - items: &248 + items: &254 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -36721,7 +36745,7 @@ paths: - updated_at - project_url examples: - default: &249 + default: &255 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36744,7 +36768,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36764,25 +36788,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *247 - - &692 + - *253 + - &696 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *248 + schema: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36803,8 +36827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *247 - - *105 + - *253 + - *63 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -36813,16 +36837,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - *40 - *41 - *17 @@ -36833,7 +36860,7 @@ paths: application/json: schema: type: array - items: &255 + items: &261 title: Projects v2 Item description: An item belonging to a project type: object @@ -36849,7 +36876,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &253 + content_type: &259 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -36899,7 +36926,7 @@ paths: - updated_at - archived_at examples: - default: &256 + default: &262 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -37573,7 +37600,7 @@ paths: type: sub_issues_progress value: headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -37593,8 +37620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *105 - - *247 + - *63 + - *253 requestBody: required: true description: Details of the item to add to the project. @@ -37631,7 +37658,7 @@ paths: description: Response content: application/json: - schema: &693 + schema: &697 title: Projects v2 Item description: An item belonging to a project type: object @@ -37644,8 +37671,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *71 - - &466 + - *70 + - &461 title: Pull Request Simple description: Pull Request Simple type: object @@ -37751,8 +37778,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true active_lock_reason: type: string @@ -37797,7 +37824,7 @@ paths: nullable: true requested_teams: type: array - items: *169 + items: *178 nullable: true head: type: object @@ -37806,7 +37833,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: @@ -37829,7 +37856,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: @@ -37848,7 +37875,7 @@ paths: _links: type: object properties: - comments: &252 + comments: &258 title: Link description: Hypermedia Link type: object @@ -37857,13 +37884,13 @@ paths: type: string required: - href - commits: *252 - statuses: *252 - html: *252 - issue: *252 - review_comments: *252 - review_comment: *252 - self: *252 + commits: *258 + statuses: *258 + html: *258 + issue: *258 + review_comments: *258 + review_comment: *258 + self: *258 required: - comments - commits @@ -37873,8 +37900,8 @@ paths: - review_comments - review_comment - self - author_association: *72 - auto_merge: &568 + author_association: *71 + auto_merge: &565 title: Auto merge description: The status of auto merging a pull request. type: object @@ -37976,7 +38003,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *253 + content_type: *259 creator: *4 created_at: type: string @@ -38009,7 +38036,7 @@ paths: - updated_at - archived_at examples: - issue: &254 + issue: &260 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -38064,7 +38091,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *254 + pull_request: *260 '304': *37 '403': *29 '401': *25 @@ -38084,9 +38111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *247 - - *105 - - &257 + - *253 + - *63 + - &263 name: item_id description: The unique identifier of the project item. in: path @@ -38094,26 +38121,29 @@ paths: schema: type: integer - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *255 + schema: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -38132,9 +38162,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *247 - - *105 - - *257 + - *253 + - *63 + - *263 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -38204,13 +38234,13 @@ paths: description: Response content: application/json: - schema: *255 + schema: *261 examples: - text_field: *256 - number_field: *256 - date_field: *256 - single_select_field: *256 - iteration_field: *256 + text_field: *262 + number_field: *262 + date_field: *262 + single_select_field: *262 + iteration_field: *262 '401': *25 '403': *29 '404': *6 @@ -38230,9 +38260,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *247 - - *105 - - *257 + - *253 + - *63 + - *263 responses: '204': description: Response @@ -38256,7 +38286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -38264,7 +38294,7 @@ paths: application/json: schema: type: array - items: &258 + items: &264 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -38330,7 +38360,7 @@ paths: - property_name - value_type examples: - default: &259 + default: &265 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38378,7 +38408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -38389,7 +38419,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *258 + items: *264 minItems: 1 maxItems: 100 required: @@ -38419,9 +38449,9 @@ paths: application/json: schema: type: array - items: *258 + items: *264 examples: - default: *259 + default: *265 '403': *29 '404': *6 x-github: @@ -38442,8 +38472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *105 - - &260 + - *63 + - &266 name: custom_property_name description: The custom property name in: path @@ -38455,9 +38485,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *264 examples: - default: &261 + default: &267 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38491,8 +38521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *105 - - *260 + - *63 + - *266 requestBody: required: true content: @@ -38561,9 +38591,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *264 examples: - default: *261 + default: *267 '403': *29 '404': *6 x-github: @@ -38586,10 +38616,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *105 - - *260 + - *63 + - *266 responses: - '204': *163 + '204': *172 '403': *29 '404': *6 x-github: @@ -38610,7 +38640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *105 + - *63 - *17 - *19 - name: repository_query @@ -38648,25 +38678,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &262 - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value + items: *104 description: List of custom property names and associated values required: - repository_id @@ -38687,7 +38699,7 @@ paths: - property_name: team value: octocat headers: - Link: *58 + Link: *54 '403': *29 '404': *6 x-github: @@ -38715,7 +38727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *105 + - *63 requestBody: required: true content: @@ -38735,7 +38747,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *262 + items: *104 required: - repository_names - properties @@ -38776,7 +38788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *105 + - *63 - *17 - *19 responses: @@ -38788,9 +38800,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38807,8 +38819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response if user is a public member @@ -38832,8 +38844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -38854,8 +38866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -38879,7 +38891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *105 + - *63 - name: type description: Specifies the types of repositories you want returned. in: query @@ -38925,11 +38937,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38948,7 +38960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *105 + - *63 requestBody: required: true content: @@ -39129,7 +39141,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &333 title: Full Repository description: Full Repository type: object @@ -39406,8 +39418,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *263 - required: *264 + properties: *268 + required: *269 nullable: true temp_clone_token: type: string @@ -39494,8 +39506,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true organization: title: Simple User @@ -39504,8 +39516,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *67 - source: *67 + parent: *66 + source: *66 forks: type: integer master_branch: @@ -39522,7 +39534,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &471 + properties: &466 url: type: string format: uri @@ -39538,12 +39550,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &472 + required: &467 - url - key - name - html_url - security_and_analysis: *265 + security_and_analysis: *270 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -39627,7 +39639,7 @@ paths: - network_count - subscribers_count examples: - default: &340 + default: &335 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40145,10 +40157,10 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - *17 - *19 - - &591 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40166,7 +40178,7 @@ paths: application/json: schema: type: array - items: &291 + items: &296 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -40201,7 +40213,7 @@ paths: source: type: string description: The name of the source - enforcement: &268 + enforcement: &273 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -40214,7 +40226,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &269 + items: &274 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -40284,7 +40296,7 @@ paths: conditions: nullable: true anyOf: - - &266 + - &271 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -40308,7 +40320,7 @@ paths: match. items: type: string - - &270 + - &275 title: Organization ruleset conditions type: object description: |- @@ -40322,7 +40334,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -40356,7 +40368,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -40378,7 +40390,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -40391,7 +40403,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &267 + items: &272 title: Repository ruleset property targeting definition type: object @@ -40424,17 +40436,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *267 + items: *272 required: - repository_property rules: type: array - items: &592 + items: &589 title: Repository Rule type: object description: A repository rule. oneOf: - - &271 + - &276 title: creation description: Only allow users with bypass permission to create matching refs. @@ -40446,7 +40458,7 @@ paths: type: string enum: - creation - - &272 + - &277 title: update description: Only allow users with bypass permission to update matching refs. @@ -40467,7 +40479,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &273 + - &278 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -40479,7 +40491,7 @@ paths: type: string enum: - deletion - - &274 + - &279 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -40491,7 +40503,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &586 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40569,7 +40581,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &275 + - &280 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -40593,7 +40605,7 @@ paths: type: string required: - required_deployment_environments - - &276 + - &281 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -40605,7 +40617,7 @@ paths: type: string enum: - required_signatures - - &277 + - &282 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -40667,7 +40679,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &278 + - &283 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -40715,7 +40727,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &279 + - &284 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -40727,7 +40739,7 @@ paths: type: string enum: - non_fast_forward - - &280 + - &285 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -40763,7 +40775,7 @@ paths: required: - operator - pattern - - &281 + - &286 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -40799,7 +40811,7 @@ paths: required: - operator - pattern - - &282 + - &287 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -40835,7 +40847,7 @@ paths: required: - operator - pattern - - &283 + - &288 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -40871,7 +40883,7 @@ paths: required: - operator - pattern - - &284 + - &289 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -40907,7 +40919,7 @@ paths: required: - operator - pattern - - &285 + - &290 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -40932,7 +40944,7 @@ paths: type: string required: - restricted_file_paths - - &286 + - &291 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -40956,7 +40968,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &287 + - &292 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -40979,7 +40991,7 @@ paths: type: string required: - restricted_file_extensions - - &288 + - &293 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -41004,7 +41016,7 @@ paths: maximum: 100 required: - max_file_size - - &289 + - &294 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -41054,7 +41066,7 @@ paths: - repository_id required: - workflows - - &290 + - &295 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -41115,7 +41127,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &587 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41176,7 +41188,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -41192,7 +41204,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 requestBody: description: Request body required: true @@ -41213,25 +41225,20 @@ paths: - push - repository default: branch - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *270 + items: *274 + conditions: *275 rules: type: array description: An array of rules within the ruleset. - items: &293 + items: &298 title: Repository Rule type: object description: A repository rule. oneOf: - - *271 - - *272 - - *273 - - *274 - - *275 - *276 - *277 - *278 @@ -41247,6 +41254,11 @@ paths: - *288 - *289 - *290 + - *291 + - *292 + - *293 + - *294 + - *295 required: - name - enforcement @@ -41284,9 +41296,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &292 + default: &297 value: id: 21 name: super cool ruleset @@ -41326,7 +41338,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -41340,8 +41352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *105 - - &593 + - *63 + - &590 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41356,7 +41368,7 @@ paths: in: query schema: type: string - - &594 + - &591 name: time_period description: |- The time period to filter by. @@ -41372,14 +41384,14 @@ paths: - week - month default: day - - &595 + - &592 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41399,7 +41411,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &594 title: Rule Suites description: Response type: array @@ -41454,7 +41466,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &595 value: - id: 21 actor_id: 12 @@ -41478,7 +41490,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41497,8 +41509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *105 - - &599 + - *63 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41514,7 +41526,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &597 title: Rule Suite description: Response type: object @@ -41613,7 +41625,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &598 value: id: 21 actor_id: 12 @@ -41648,7 +41660,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41674,7 +41686,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41686,11 +41698,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 '404': *6 - '500': *106 + '500': *105 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -41706,7 +41718,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41732,16 +41744,16 @@ paths: - tag - push - repository - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *270 + items: *274 + conditions: *275 rules: description: An array of rules within the ruleset. type: array - items: *293 + items: *298 examples: default: value: @@ -41776,11 +41788,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 '404': *6 - '500': *106 + '500': *105 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -41796,7 +41808,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41807,7 +41819,7 @@ paths: '204': description: Response '404': *6 - '500': *106 + '500': *105 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -41819,7 +41831,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *105 + - *63 - *17 - *19 - name: ruleset_id @@ -41835,7 +41847,7 @@ paths: application/json: schema: type: array - items: &294 + items: &299 title: Ruleset version type: object description: The historical version of a ruleset @@ -41859,7 +41871,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &600 value: - version_id: 3 actor: @@ -41877,7 +41889,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41894,7 +41906,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41912,9 +41924,9 @@ paths: description: Response content: application/json: - schema: &604 + schema: &601 allOf: - - *294 + - *299 - type: object required: - state @@ -41961,7 +41973,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41983,15 +41995,53 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *105 - - *295 - - *296 - - *297 - - *298 + - *63 + - &602 + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + - &603 + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default + secret patterns are returned. To return generic patterns, pass the token + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + - &604 + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + - &605 + name: sort + description: The property to sort the results by. `created` means when the + alert was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created - *48 - *19 - *17 - - &605 + - &606 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42001,7 +42051,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42011,10 +42061,42 @@ paths: required: false schema: type: string - - *299 - - *300 - - *301 - - *302 + - &608 + name: validity + in: query + description: A comma-separated list of validities that, when present, will + return alerts that match the validities in this list. Valid options are + `active`, `inactive`, and `unknown`. + required: false + schema: + type: string + - &609 + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts + by the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + - &610 + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts + by the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + - &611 + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false responses: '200': description: Response @@ -42022,13 +42104,593 @@ paths: application/json: schema: type: array - items: *303 + items: + type: object + properties: + number: *158 + created_at: *159 + updated_at: + type: string + description: 'The time that the alert was last updated in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + url: *161 + html_url: *162 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this + alert. + state: &612 + description: Sets the state of the secret scanning alert. You + must provide `resolution` when you set the state to `resolved`. + type: string + enum: + - open + - resolved + resolution: &613 + type: string + description: "**Required when the `state` is `resolved`.** The + reason for resolving the alert." + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: *53 + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected + secret. + nullable: true + push_protection_bypassed_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in + ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection + bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this + alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple + repositories in the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert + is base64 encoded + nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &614 + - &616 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &617 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &618 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &619 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &620 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &621 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &622 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &623 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &624 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &625 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &626 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &627 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &628 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true + has_more_locations: + type: boolean + description: A boolean value representing whether or not the + token in the alert was detected in more than one location. + assigned_to: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true examples: - default: *304 + default: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42053,7 +42715,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *105 + - *63 responses: '200': description: Response @@ -42065,7 +42727,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &306 + pattern_config_version: &301 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -42074,7 +42736,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &305 + items: &300 type: object properties: token_type: @@ -42140,7 +42802,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *305 + items: *300 examples: default: value: @@ -42189,7 +42851,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *105 + - *63 requestBody: required: true content: @@ -42197,7 +42859,7 @@ paths: schema: type: object properties: - pattern_config_version: *306 + pattern_config_version: *301 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -42223,7 +42885,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *306 + custom_pattern_version: *301 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -42277,7 +42939,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *105 + - *63 - *48 - name: sort description: The property to sort the results by. @@ -42321,7 +42983,7 @@ paths: application/json: schema: type: array - items: &627 + items: &632 description: A repository security advisory. type: object properties: @@ -42541,7 +43203,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 credits_detailed: type: array nullable: true @@ -42551,7 +43213,7 @@ paths: type: object properties: user: *4 - type: *307 + type: *302 state: type: string description: The state of the user's acceptance of the @@ -42575,7 +43237,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *169 + items: *178 private_fork: readOnly: true nullable: true @@ -42612,7 +43274,7 @@ paths: - private_fork additionalProperties: false examples: - default: &628 + default: &633 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -42991,7 +43653,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *105 + - *63 responses: '200': description: Response @@ -42999,9 +43661,9 @@ paths: application/json: schema: type: array - items: *308 + items: *303 examples: - default: *227 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43024,8 +43686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -43050,8 +43712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -43080,13 +43742,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &694 + schema: &698 type: object properties: total_minutes_used: @@ -43156,7 +43818,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &695 + default: &699 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -43186,13 +43848,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &696 + schema: &700 type: object properties: total_gigabytes_bandwidth_used: @@ -43210,7 +43872,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &697 + default: &701 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -43236,13 +43898,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &701 + schema: &705 type: object properties: days_left_in_billing_cycle: @@ -43260,7 +43922,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &702 + default: &706 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -43284,7 +43946,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Immutable releases settings response @@ -43333,7 +43995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -43390,7 +44052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *105 + - *63 - *19 - *17 responses: @@ -43408,9 +44070,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43429,7 +44091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *105 + - *63 requestBody: required: true content: @@ -43478,8 +44140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -43501,8 +44163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -43525,7 +44187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -43543,7 +44205,7 @@ paths: type: integer network_configurations: type: array - items: &309 + items: &304 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -43602,7 +44264,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43621,7 +44283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -43663,9 +44325,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: &310 + default: &305 value: id: 123456789ABCDEF name: My network configuration @@ -43693,8 +44355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 - - &311 + - *63 + - &306 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -43706,11 +44368,11 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: *310 + default: *305 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43729,8 +44391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 - - *311 + - *63 + - *306 requestBody: required: true content: @@ -43769,9 +44431,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: *310 + default: *305 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43790,8 +44452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *105 - - *311 + - *63 + - *306 responses: '204': description: Response @@ -43814,7 +44476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *105 + - *63 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -43868,7 +44530,7 @@ paths: subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43898,8 +44560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *105 - - *65 + - *63 + - *64 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -43931,13 +44593,13 @@ paths: application/json: schema: type: array - items: *312 + items: *307 examples: - default: *313 - '500': *106 + default: *308 + '500': *105 '403': *29 '404': *6 - '422': *314 + '422': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43955,7 +44617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *105 + - *63 - *17 - *19 responses: @@ -43965,11 +44627,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -43989,7 +44651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *105 + - *63 requestBody: required: true content: @@ -44061,7 +44723,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &310 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -44124,8 +44786,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 nullable: true members_count: type: integer @@ -44388,7 +45050,7 @@ paths: - repos_count - organization examples: - default: &316 + default: &311 value: id: 1 node_id: MDQ6VGVhbTE= @@ -44458,16 +45120,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *105 - - *65 + - *63 + - *64 responses: '200': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 x-github: githubCloudOnly: false @@ -44488,8 +45150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *105 - - *65 + - *63 + - *64 requestBody: required: false content: @@ -44551,16 +45213,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '201': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 '422': *15 '403': *29 @@ -44585,8 +45247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -44612,8 +45274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *105 - - *65 + - *63 + - *64 - *48 - *17 - *19 @@ -44630,7 +45292,7 @@ paths: application/json: schema: type: array - items: &317 + items: &312 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -44709,7 +45371,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *73 + reactions: *72 required: - author - body @@ -44729,7 +45391,7 @@ paths: - updated_at - url examples: - default: &645 + default: &650 value: - author: login: octocat @@ -44779,7 +45441,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44803,8 +45465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *105 - - *65 + - *63 + - *64 requestBody: required: true content: @@ -44838,9 +45500,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: &318 + default: &313 value: author: login: octocat @@ -44912,9 +45574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *105 - - *65 - - &319 + - *63 + - *64 + - &314 name: discussion_number description: The number that identifies the discussion. in: path @@ -44926,9 +45588,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44950,9 +45612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: false content: @@ -44975,9 +45637,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: &646 + default: &651 value: author: login: octocat @@ -45047,9 +45709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 responses: '204': description: Response @@ -45075,9 +45737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 - *48 - *17 - *19 @@ -45088,7 +45750,7 @@ paths: application/json: schema: type: array - items: &320 + items: &315 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -45145,7 +45807,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *73 + reactions: *72 required: - author - body @@ -45160,7 +45822,7 @@ paths: - updated_at - url examples: - default: &647 + default: &652 value: - author: login: octocat @@ -45204,7 +45866,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45228,9 +45890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: true content: @@ -45252,9 +45914,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: &321 + default: &316 value: author: login: octocat @@ -45320,10 +45982,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - &322 + - *63 + - *64 + - *314 + - &317 name: comment_number description: The number that identifies the comment. in: path @@ -45335,9 +45997,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45359,10 +46021,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 requestBody: required: true content: @@ -45384,9 +46046,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: &648 + default: &653 value: author: login: octocat @@ -45450,10 +46112,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 responses: '204': description: Response @@ -45479,10 +46141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -45508,7 +46170,7 @@ paths: application/json: schema: type: array - items: &323 + items: &318 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -45551,7 +46213,7 @@ paths: - content - created_at examples: - default: &325 + default: &320 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45577,7 +46239,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45601,10 +46263,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 requestBody: required: true content: @@ -45637,9 +46299,9 @@ paths: team discussion comment content: application/json: - schema: *323 + schema: *318 examples: - default: &324 + default: &319 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45668,9 +46330,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45693,11 +46355,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *105 - - *65 - - *319 - - *322 - - &326 + - *63 + - *64 + - *314 + - *317 + - &321 name: reaction_id description: The unique identifier of the reaction. in: path @@ -45729,9 +46391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -45757,11 +46419,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45785,9 +46447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: true content: @@ -45819,16 +46481,16 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45851,10 +46513,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *105 - - *65 - - *319 - - *326 + - *63 + - *64 + - *314 + - *321 responses: '204': description: Response @@ -45878,8 +46540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -45889,11 +46551,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45913,8 +46575,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *105 - - *65 + - *63 + - *64 - name: role description: Filters members returned by their role in the team. in: query @@ -45937,9 +46599,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45967,15 +46629,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 responses: '200': description: Response content: application/json: - schema: &327 + schema: &322 title: Team Membership description: Team Membership type: object @@ -46002,7 +46664,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &649 + response-if-user-is-a-team-maintainer: &654 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46038,9 +46700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 requestBody: required: false content: @@ -46065,9 +46727,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-users-membership-with-team-is-now-pending: &650 + response-if-users-membership-with-team-is-now-pending: &655 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46102,9 +46764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 responses: '204': description: Response @@ -46129,8 +46791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -46140,7 +46802,7 @@ paths: application/json: schema: type: array - items: &328 + items: &323 title: Team Project description: A team's access to a project. type: object @@ -46208,7 +46870,7 @@ paths: - updated_at - permissions examples: - default: &651 + default: &656 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46248,7 +46910,7 @@ paths: write: true admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46271,9 +46933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *105 - - *65 - - &329 + - *63 + - *64 + - &324 name: project_id description: The unique identifier of the project. in: path @@ -46285,9 +46947,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *323 examples: - default: &652 + default: &657 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46349,9 +47011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *105 - - *65 - - *329 + - *63 + - *64 + - *324 requestBody: required: false content: @@ -46417,9 +47079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *105 - - *65 - - *329 + - *63 + - *64 + - *324 responses: '204': description: Response @@ -46446,8 +47108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -46457,11 +47119,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46488,16 +47150,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &653 + schema: &658 title: Team Repository description: A team's access to a repository. type: object @@ -46520,8 +47182,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true forks: type: integer @@ -47066,10 +47728,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 requestBody: required: false content: @@ -47114,10 +47776,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 responses: '204': description: Response @@ -47141,8 +47803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -47152,9 +47814,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - response-if-child-teams-exist: &654 + response-if-child-teams-exist: &659 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47182,7 +47844,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47207,7 +47869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *105 + - *63 - name: security_product in: path description: The security feature to enable or disable. @@ -47281,7 +47943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &332 + - &327 name: column_id description: The unique identifier of the column. in: path @@ -47293,7 +47955,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &328 title: Project Column description: Project columns contain cards of work. type: object @@ -47339,7 +48001,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &329 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -47374,7 +48036,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *332 + - *327 requestBody: required: true content: @@ -47398,9 +48060,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *334 + default: *329 '304': *37 '403': *29 '401': *25 @@ -47425,7 +48087,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *332 + - *327 responses: '204': description: Response @@ -47454,7 +48116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *332 + - *327 requestBody: required: true content: @@ -47514,15 +48176,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *329 + - *324 responses: '200': description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: &335 + default: &330 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -47579,7 +48241,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *329 + - *324 requestBody: required: false content: @@ -47625,9 +48287,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *335 + default: *330 '404': description: Not Found if the authenticated user does not have access to the project @@ -47648,7 +48310,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -47671,7 +48333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *329 + - *324 responses: '204': description: Delete Success @@ -47692,7 +48354,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *331 '404': *6 x-github: githubCloudOnly: false @@ -47716,7 +48378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *329 + - *324 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -47743,9 +48405,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 '422': *15 '304': *37 @@ -47773,8 +48435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *329 - - *63 + - *324 + - *59 requestBody: required: false content: @@ -47826,8 +48488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *329 - - *63 + - *324 + - *59 responses: '204': description: Response @@ -47858,8 +48520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *329 - - *63 + - *324 + - *59 responses: '200': description: Response @@ -47932,7 +48594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *329 + - *324 - *17 - *19 responses: @@ -47942,7 +48604,7 @@ paths: application/json: schema: type: array - items: *333 + items: *328 examples: default: value: @@ -47955,7 +48617,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -47980,7 +48642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *329 + - *324 requestBody: required: true content: @@ -48003,7 +48665,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: default: value: @@ -48068,7 +48730,7 @@ paths: resources: type: object properties: - core: &337 + core: &332 title: Rate Limit type: object properties: @@ -48085,21 +48747,21 @@ paths: - remaining - reset - used - graphql: *337 - search: *337 - code_search: *337 - source_import: *337 - integration_manifest: *337 - code_scanning_upload: *337 - actions_runner_registration: *337 - scim: *337 - dependency_snapshots: *337 - dependency_sbom: *337 - code_scanning_autofix: *337 + graphql: *332 + search: *332 + code_search: *332 + source_import: *332 + integration_manifest: *332 + code_scanning_upload: *332 + actions_runner_registration: *332 + scim: *332 + dependency_snapshots: *332 + dependency_sbom: *332 + code_scanning_autofix: *332 required: - core - search - rate: *337 + rate: *332 required: - rate - resources @@ -48204,14 +48866,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *338 + schema: *333 examples: default-response: summary: Default response @@ -48712,7 +49374,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *339 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48730,8 +49392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -48978,10 +49640,10 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 - '307': &341 + default: *335 + '307': &336 description: Temporary Redirect content: application/json: @@ -49010,8 +49672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -49033,7 +49695,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *341 + '307': *336 '404': *6 '409': *47 x-github: @@ -49057,11 +49719,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - - &372 + - &367 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49084,7 +49746,7 @@ paths: type: integer artifacts: type: array - items: &342 + items: &337 title: Artifact description: An artifact type: object @@ -49162,7 +49824,7 @@ paths: - expires_at - updated_at examples: - default: &373 + default: &368 value: total_count: 2 artifacts: @@ -49201,7 +49863,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49223,9 +49885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *330 - - *331 - - &343 + - *325 + - *326 + - &338 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49237,7 +49899,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *337 examples: default: value: @@ -49275,9 +49937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *330 - - *331 - - *343 + - *325 + - *326 + - *338 responses: '204': description: Response @@ -49301,9 +49963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *330 - - *331 - - *343 + - *325 + - *326 + - *338 - name: archive_format in: path required: true @@ -49317,7 +49979,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49340,14 +50002,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *344 + schema: *339 examples: default: value: @@ -49373,11 +50035,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - - &345 + - &340 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -49411,7 +50073,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &341 title: Repository actions caches description: Repository actions caches type: object @@ -49453,7 +50115,7 @@ paths: - total_count - actions_caches examples: - default: &347 + default: &342 value: total_count: 1 actions_caches: @@ -49465,7 +50127,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49485,23 +50147,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *330 - - *331 + - *325 + - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *345 + - *340 responses: '200': description: Response content: application/json: - schema: *346 + schema: *341 examples: - default: *347 + default: *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49521,8 +50183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *330 - - *331 + - *325 + - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49553,9 +50215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *330 - - *331 - - &348 + - *325 + - *326 + - &343 name: job_id description: The unique identifier of the job. in: path @@ -49567,7 +50229,7 @@ paths: description: Response content: application/json: - schema: &376 + schema: &371 title: Job description: Information of a job execution in a workflow run type: object @@ -49874,9 +50536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *330 - - *331 - - *348 + - *325 + - *326 + - *343 responses: '302': description: Response @@ -49904,9 +50566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *330 - - *331 - - *348 + - *325 + - *326 + - *343 requestBody: required: false content: @@ -49927,7 +50589,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -49951,8 +50613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Status response @@ -50002,8 +50664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -50037,7 +50699,7 @@ paths: description: Empty response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -50066,8 +50728,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -50085,7 +50747,7 @@ paths: type: integer secrets: type: array - items: &378 + items: &373 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50105,7 +50767,7 @@ paths: - created_at - updated_at examples: - default: &379 + default: &374 value: total_count: 2 secrets: @@ -50116,7 +50778,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50138,9 +50800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *330 - - *331 - - *349 + - *325 + - *326 + - *344 - *19 responses: '200': @@ -50157,7 +50819,7 @@ paths: type: integer variables: type: array - items: &382 + items: &377 title: Actions Variable type: object properties: @@ -50187,7 +50849,7 @@ paths: - created_at - updated_at examples: - default: &383 + default: &378 value: total_count: 2 variables: @@ -50200,7 +50862,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50220,8 +50882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -50230,12 +50892,12 @@ paths: schema: type: object properties: - enabled: &351 + enabled: &346 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *122 - selected_actions_url: *350 - sha_pinning_required: *123 + allowed_actions: *127 + selected_actions_url: *345 + sha_pinning_required: *128 required: - enabled examples: @@ -50263,8 +50925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50275,9 +50937,9 @@ paths: schema: type: object properties: - enabled: *351 - allowed_actions: *122 - sha_pinning_required: *123 + enabled: *346 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled examples: @@ -50307,14 +50969,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &352 + schema: &347 type: object properties: access_level: @@ -50331,7 +50993,7 @@ paths: required: - access_level examples: - default: &353 + default: &348 value: access_level: organization x-github: @@ -50355,15 +51017,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *352 + schema: *347 examples: - default: *353 + default: *348 responses: '204': description: Response @@ -50387,14 +51049,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: default: value: @@ -50418,8 +51080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Empty response for successful settings update @@ -50429,7 +51091,7 @@ paths: required: true content: application/json: - schema: *355 + schema: *350 examples: default: summary: Set retention days @@ -50453,16 +51115,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *124 + schema: *129 examples: - default: *356 + default: *351 '404': *6 x-github: enabledForGitHubApps: true @@ -50481,8 +51143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50492,7 +51154,7 @@ paths: required: true content: application/json: - schema: *124 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -50516,16 +51178,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *357 + schema: *352 examples: - default: *125 + default: *130 '403': *29 '404': *6 x-github: @@ -50545,15 +51207,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *358 + schema: *353 examples: - default: *125 + default: *130 responses: '204': description: Empty response for successful settings update @@ -50577,16 +51239,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *127 + schema: *132 examples: - default: *128 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50605,8 +51267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50614,9 +51276,9 @@ paths: required: false content: application/json: - schema: *127 + schema: *132 examples: - selected_actions: *128 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50638,16 +51300,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *359 + schema: *354 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50668,8 +51330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Success response @@ -50680,9 +51342,9 @@ paths: required: true content: application/json: - schema: *360 + schema: *355 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50709,8 +51371,8 @@ paths: in: query schema: type: string - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -50728,11 +51390,11 @@ paths: type: integer runners: type: array - items: *139 + items: *144 examples: - default: *140 + default: *145 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50754,8 +51416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -50763,9 +51425,9 @@ paths: application/json: schema: type: array - items: *361 + items: *356 examples: - default: *362 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50787,8 +51449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -50831,7 +51493,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *363 + '201': *358 '404': *6 '422': *7 '409': *47 @@ -50862,16 +51524,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: *364 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50899,16 +51561,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50930,17 +51592,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: '200': description: Response content: application/json: - schema: *139 + schema: *144 examples: - default: *366 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50961,9 +51623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: '204': description: Response @@ -50989,11 +51651,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: - '200': *143 + '200': *148 '404': *6 x-github: githubCloudOnly: false @@ -51015,9 +51677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 requestBody: required: true content: @@ -51041,7 +51703,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51065,9 +51727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 requestBody: required: true content: @@ -51092,7 +51754,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51116,11 +51778,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: - '200': *367 + '200': *362 '404': *6 x-github: githubCloudOnly: false @@ -51147,12 +51809,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 - - *368 + - *325 + - *326 + - *143 + - *363 responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51178,9 +51840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *330 - - *331 - - &386 + - *325 + - *326 + - &381 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -51188,7 +51850,7 @@ paths: required: false schema: type: string - - &387 + - &382 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51196,7 +51858,7 @@ paths: required: false schema: type: string - - &388 + - &383 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51205,7 +51867,7 @@ paths: required: false schema: type: string - - &389 + - &384 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -51232,7 +51894,7 @@ paths: - pending - *17 - *19 - - &390 + - &385 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -51241,7 +51903,7 @@ paths: schema: type: string format: date-time - - &369 + - &364 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51250,13 +51912,13 @@ paths: schema: type: boolean default: false - - &391 + - &386 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &392 + - &387 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51279,7 +51941,7 @@ paths: type: integer workflow_runs: type: array - items: &370 + items: &365 title: Workflow Run description: An invocation of a workflow type: object @@ -51374,7 +52036,7 @@ paths: that triggered the run. type: array nullable: true - items: *76 + items: *75 created_at: type: string format: date-time @@ -51427,7 +52089,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &414 + properties: &409 id: type: string description: SHA for the commit @@ -51478,7 +52140,7 @@ paths: - name - email nullable: true - required: &415 + required: &410 - id - tree_id - message @@ -51486,8 +52148,8 @@ paths: - author - committer nullable: true - repository: *137 - head_repository: *137 + repository: *142 + head_repository: *142 head_repository_id: type: integer example: 5 @@ -51525,7 +52187,7 @@ paths: - workflow_url - pull_requests examples: - default: &393 + default: &388 value: total_count: 1 workflow_runs: @@ -51739,7 +52401,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51761,24 +52423,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *330 - - *331 - - &371 + - *325 + - *326 + - &366 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *369 + - *364 responses: '200': description: Response content: application/json: - schema: *370 + schema: *365 examples: - default: &374 + default: &369 value: id: 30433642 name: Build @@ -52019,9 +52681,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '204': description: Response @@ -52044,9 +52706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -52165,15 +52827,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52200,12 +52862,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 - *17 - *19 - - *372 + - *367 responses: '200': description: Response @@ -52221,11 +52883,11 @@ paths: type: integer artifacts: type: array - items: *342 + items: *337 examples: - default: *373 + default: *368 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52247,25 +52909,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *330 - - *331 - - *371 - - &375 + - *325 + - *326 + - *366 + - &370 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *369 + - *364 responses: '200': description: Response content: application/json: - schema: *370 + schema: *365 examples: - default: *374 + default: *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52288,10 +52950,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *330 - - *331 - - *371 - - *375 + - *325 + - *326 + - *366 + - *370 - *17 - *19 responses: @@ -52309,9 +52971,9 @@ paths: type: integer jobs: type: array - items: *376 + items: *371 examples: - default: &377 + default: &372 value: total_count: 1 jobs: @@ -52400,7 +53062,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -52424,10 +53086,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *330 - - *331 - - *371 - - *375 + - *325 + - *326 + - *366 + - *370 responses: '302': description: Response @@ -52455,15 +53117,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '202': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52490,9 +53152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: true content: @@ -52559,15 +53221,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '202': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52594,9 +53256,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -52626,11 +53288,11 @@ paths: type: integer jobs: type: array - items: *376 + items: *371 examples: - default: *377 + default: *372 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52653,9 +53315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '302': description: Response @@ -52682,14 +53344,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '204': description: Response '403': *29 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52711,9 +53373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -52773,7 +53435,7 @@ paths: items: type: object properties: - type: &493 + type: &488 type: string description: The type of reviewer. enum: @@ -52783,7 +53445,7 @@ paths: reviewer: anyOf: - *4 - - *169 + - *178 required: - environment - wait_timer @@ -52858,9 +53520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: true content: @@ -52907,7 +53569,7 @@ paths: application/json: schema: type: array - items: &488 + items: &483 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52995,8 +53657,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -53013,7 +53675,7 @@ paths: - created_at - updated_at examples: - default: &489 + default: &484 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53069,9 +53731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: false content: @@ -53092,7 +53754,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53115,9 +53777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: false content: @@ -53138,7 +53800,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53170,9 +53832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -53309,8 +53971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -53328,11 +53990,11 @@ paths: type: integer secrets: type: array - items: *378 + items: *373 examples: - default: *379 + default: *374 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53355,16 +54017,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *380 + schema: *375 examples: - default: *381 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53386,17 +54048,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *378 + schema: *373 examples: - default: &506 + default: &501 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53422,9 +54084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -53455,7 +54117,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53481,9 +54143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -53508,9 +54170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *330 - - *331 - - *349 + - *325 + - *326 + - *344 - *19 responses: '200': @@ -53527,11 +54189,11 @@ paths: type: integer variables: type: array - items: *382 + items: *377 examples: - default: *383 + default: *378 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53552,8 +54214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -53580,7 +54242,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53605,17 +54267,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 responses: '200': description: Response content: application/json: - schema: *382 + schema: *377 examples: - default: &507 + default: &502 value: name: USERNAME value: octocat @@ -53641,9 +54303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 requestBody: required: true content: @@ -53685,9 +54347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 responses: '204': description: Response @@ -53712,8 +54374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -53731,7 +54393,7 @@ paths: type: integer workflows: type: array - items: &384 + items: &379 title: Workflow description: A GitHub Actions workflow type: object @@ -53815,7 +54477,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53838,9 +54500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *330 - - *331 - - &385 + - *325 + - *326 + - &380 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53855,7 +54517,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *379 examples: default: value: @@ -53888,9 +54550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53915,9 +54577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53968,9 +54630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53997,19 +54659,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *330 - - *331 + - *325 + - *326 + - *380 + - *381 + - *382 + - *383 + - *384 + - *17 + - *19 - *385 + - *364 - *386 - *387 - - *388 - - *389 - - *17 - - *19 - - *390 - - *369 - - *391 - - *392 responses: '200': description: Response @@ -54025,11 +54687,11 @@ paths: type: integer workflow_runs: type: array - items: *370 + items: *365 examples: - default: *393 + default: *388 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54059,9 +54721,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '200': description: Response @@ -54122,8 +54784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *330 - - *331 + - *325 + - *326 - *48 - *17 - *40 @@ -54268,7 +54930,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '422': *7 x-github: githubCloudOnly: false @@ -54287,8 +54949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -54300,9 +54962,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -54325,8 +54987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *330 - - *331 + - *325 + - *326 - name: assignee in: path required: true @@ -54362,8 +55024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -54475,8 +55137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *40 - *41 @@ -54532,7 +55194,7 @@ paths: initiator: type: string examples: - default: *394 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54552,8 +55214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -54561,7 +55223,7 @@ paths: application/json: schema: type: array - items: &395 + items: &390 title: Autolink reference description: An autolink reference. type: object @@ -54615,8 +55277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -54655,9 +55317,9 @@ paths: description: response content: application/json: - schema: *395 + schema: *390 examples: - default: &396 + default: &391 value: id: 1 key_prefix: TICKET- @@ -54688,9 +55350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *330 - - *331 - - &397 + - *325 + - *326 + - &392 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54702,9 +55364,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: *396 + default: *391 '404': *6 x-github: githubCloudOnly: false @@ -54724,9 +55386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *330 - - *331 - - *397 + - *325 + - *326 + - *392 responses: '204': description: Response @@ -54750,8 +55412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response if Dependabot is enabled @@ -54799,8 +55461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -54821,8 +55483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -54842,8 +55504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *330 - - *331 + - *325 + - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54881,7 +55543,7 @@ paths: - url protected: type: boolean - protection: &399 + protection: &394 title: Branch Protection description: Branch Protection type: object @@ -54923,7 +55585,7 @@ paths: required: - contexts - checks - enforce_admins: &402 + enforce_admins: &397 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54938,7 +55600,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &404 + required_pull_request_reviews: &399 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54959,7 +55621,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *169 + items: *178 apps: description: The list of apps with review dismissal access. @@ -54988,7 +55650,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *169 + items: *178 apps: description: The list of apps allowed to bypass pull request requirements. @@ -55014,7 +55676,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &401 + restrictions: &396 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55077,7 +55739,7 @@ paths: type: string teams: type: array - items: *169 + items: *178 apps: type: array items: @@ -55273,7 +55935,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -55291,9 +55953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *330 - - *331 - - &400 + - *325 + - *326 + - &395 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -55307,14 +55969,14 @@ paths: description: Response content: application/json: - schema: &410 + schema: &405 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &462 + commit: &457 title: Commit description: Commit type: object @@ -55348,7 +56010,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &398 + properties: &393 name: type: string example: '"Chris Wanstrath"' @@ -55363,7 +56025,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true message: type: string @@ -55384,7 +56046,7 @@ paths: required: - sha - url - verification: &513 + verification: &508 title: Verification type: object properties: @@ -55418,12 +56080,12 @@ paths: nullable: true oneOf: - *4 - - *146 + - *151 committer: nullable: true oneOf: - *4 - - *146 + - *151 parents: type: array items: @@ -55454,7 +56116,7 @@ paths: type: integer files: type: array - items: &475 + items: &470 title: Diff Entry description: Diff Entry type: object @@ -55538,7 +56200,7 @@ paths: - self protected: type: boolean - protection: *399 + protection: *394 protection_url: type: string format: uri @@ -55645,7 +56307,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *339 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -55667,15 +56329,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *399 + schema: *394 examples: default: value: @@ -55869,9 +56531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -56126,7 +56788,7 @@ paths: url: type: string format: uri - required_status_checks: &407 + required_status_checks: &402 title: Status Check Policy description: Status Check Policy type: object @@ -56202,7 +56864,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 apps: type: array items: *5 @@ -56220,7 +56882,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 apps: type: array items: *5 @@ -56278,7 +56940,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *401 + restrictions: *396 required_conversation_resolution: type: object properties: @@ -56390,9 +57052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56417,17 +57079,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &403 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56449,17 +57111,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *403 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56478,9 +57140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56505,17 +57167,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *404 + schema: *399 examples: - default: &405 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56611,9 +57273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -56711,9 +57373,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *399 examples: - default: *405 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -56734,9 +57396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56763,17 +57425,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &406 + default: &401 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56796,17 +57458,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *406 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -56826,9 +57488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56853,17 +57515,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: &408 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56889,9 +57551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -56943,9 +57605,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: *408 + default: *403 '404': *6 '422': *15 x-github: @@ -56967,9 +57629,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56993,9 +57655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57029,9 +57691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57098,9 +57760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57164,9 +57826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: content: application/json: @@ -57232,15 +57894,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *401 + schema: *396 examples: default: value: @@ -57331,9 +57993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -57356,9 +58018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57368,7 +58030,7 @@ paths: type: array items: *5 examples: - default: &409 + default: &404 value: - id: 1 slug: octoapp @@ -57425,9 +58087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57461,7 +58123,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57482,9 +58144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57518,7 +58180,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57539,9 +58201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57575,7 +58237,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57597,9 +58259,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57607,9 +58269,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '404': *6 x-github: githubCloudOnly: false @@ -57629,9 +58291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57667,9 +58329,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57690,9 +58352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57728,9 +58390,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57751,9 +58413,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: content: application/json: @@ -57788,9 +58450,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57812,9 +58474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57824,7 +58486,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '404': *6 x-github: githubCloudOnly: false @@ -57848,9 +58510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57883,7 +58545,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -57908,9 +58570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57943,7 +58605,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -57968,9 +58630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -58003,7 +58665,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -58030,9 +58692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -58054,7 +58716,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *405 examples: default: value: @@ -58170,8 +58832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -58450,7 +59112,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &406 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58561,16 +59223,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *76 - deployment: &713 + items: *75 + deployment: &717 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58637,8 +59299,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -58850,9 +59512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *330 - - *331 - - &412 + - *325 + - *326 + - &407 name: check_run_id description: The unique identifier of the check run. in: path @@ -58864,9 +59526,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *406 examples: - default: &413 + default: &408 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58966,9 +59628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 requestBody: required: true content: @@ -59208,9 +59870,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *406 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59230,9 +59892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 - *17 - *19 responses: @@ -59307,7 +59969,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59327,15 +59989,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -59373,8 +60035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -59396,7 +60058,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &416 + schema: &411 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59460,7 +60122,7 @@ paths: nullable: true pull_requests: type: array - items: *76 + items: *75 nullable: true app: title: GitHub app @@ -59471,9 +60133,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - repository: *137 + properties: *67 + required: *68 + repository: *142 created_at: type: string format: date-time @@ -59482,12 +60144,12 @@ paths: type: string format: date-time nullable: true - head_commit: &739 + head_commit: &743 title: Simple Commit description: A commit. type: object - properties: *414 - required: *415 + properties: *409 + required: *410 latest_check_runs_count: type: integer check_runs_url: @@ -59515,7 +60177,7 @@ paths: - check_runs_url - pull_requests examples: - default: &417 + default: &412 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59806,9 +60468,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59827,8 +60489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -59889,7 +60551,7 @@ paths: required: - app_id - setting - repository: *137 + repository: *142 examples: default: value: @@ -60137,9 +60799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *330 - - *331 - - &418 + - *325 + - *326 + - &413 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60151,9 +60813,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60176,17 +60838,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *330 - - *331 - - *418 - - &468 + - *325 + - *326 + - *413 + - &463 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &469 + - &464 name: status description: Returns check runs with the specified `status`. in: query @@ -60225,9 +60887,9 @@ paths: type: integer check_runs: type: array - items: *411 + items: *406 examples: - default: &470 + default: &465 value: total_count: 1 check_runs: @@ -60309,7 +60971,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60329,15 +60991,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *330 - - *331 - - *418 + - *325 + - *326 + - *413 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -60364,21 +61026,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *330 - - *331 - - *419 - - *420 + - *325 + - *326 + - *414 + - *415 - *19 - *17 - - &437 + - &432 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *421 - - &438 + schema: *416 + - &433 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60403,13 +61065,13 @@ paths: be returned. in: query required: false - schema: *422 + schema: *417 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *423 + schema: *418 responses: '200': description: Response @@ -60420,14 +61082,14 @@ paths: items: type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: *424 - state: *158 - fixed_at: *154 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: *419 + state: *167 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -60435,12 +61097,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: *425 - dismissed_comment: *426 - rule: *427 - tool: *428 - most_recent_instance: *429 + dismissed_at: *164 + dismissed_reason: *420 + dismissed_comment: *421 + rule: *422 + tool: *423 + most_recent_instance: *424 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60566,14 +61228,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &430 + '403': &425 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60593,9 +61255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *330 - - *331 - - &431 + - *325 + - *326 + - &426 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60603,23 +61265,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *54 + schema: *158 responses: '200': description: Response content: application/json: - schema: &432 + schema: &427 type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: *424 - state: *158 - fixed_at: *154 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: *419 + state: *167 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -60627,9 +61289,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: *425 - dismissed_comment: *426 + dismissed_at: *164 + dismissed_reason: *420 + dismissed_comment: *421 rule: type: object properties: @@ -60683,8 +61345,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *428 - most_recent_instance: *429 + tool: *423 + most_recent_instance: *424 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60783,9 +61445,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60803,9 +61465,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: true content: @@ -60820,8 +61482,8 @@ paths: enum: - open - dismissed - dismissed_reason: *425 - dismissed_comment: *426 + dismissed_reason: *420 + dismissed_comment: *421 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60840,7 +61502,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *427 examples: default: value: @@ -60916,14 +61578,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &436 + '403': &431 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60943,15 +61605,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 responses: '200': description: Response content: application/json: - schema: &433 + schema: &428 type: object properties: status: @@ -60977,13 +61639,13 @@ paths: - description - started_at examples: - default: &434 + default: &429 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &435 + '400': &430 description: Bad Request content: application/json: @@ -60994,9 +61656,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61019,29 +61681,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 responses: '200': description: OK content: application/json: - schema: *433 + schema: *428 examples: - default: *434 + default: *429 '202': description: Accepted content: application/json: - schema: *433 + schema: *428 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *435 + '400': *430 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61051,7 +61713,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61073,9 +61735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: false content: @@ -61120,12 +61782,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *435 - '403': *436 + '400': *430 + '403': *431 '404': *6 '422': description: Unprocessable Entity - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61145,13 +61807,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 - *19 - *17 - - *437 - - *438 + - *432 + - *433 responses: '200': description: Response @@ -61159,7 +61821,7 @@ paths: application/json: schema: type: array - items: *429 + items: *424 examples: default: value: @@ -61198,9 +61860,9 @@ paths: end_column: 50 classifications: - source - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61232,25 +61894,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *330 - - *331 - - *419 - - *420 + - *325 + - *326 + - *414 + - *415 - *19 - *17 - - *438 + - *433 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *421 + schema: *416 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &441 + schema: &436 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -61271,23 +61933,23 @@ paths: application/json: schema: type: array - items: &442 + items: &437 type: object properties: - ref: *421 - commit_sha: &450 + ref: *416 + commit_sha: &445 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *439 + analysis_key: *434 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *440 + category: *435 error: type: string example: error reading field xyz @@ -61311,8 +61973,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *441 - tool: *428 + sarif_id: *436 + tool: *423 deletable: type: boolean warning: @@ -61373,9 +62035,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61409,8 +62071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61423,7 +62085,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: response: summary: application/json response @@ -61477,14 +62139,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *430 + '403': *425 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61564,8 +62226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61618,9 +62280,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *436 + '403': *431 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61640,8 +62302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -61649,7 +62311,7 @@ paths: application/json: schema: type: array - items: &443 + items: &438 title: CodeQL Database description: A CodeQL database. type: object @@ -61760,9 +62422,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61789,8 +62451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61802,7 +62464,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *438 examples: default: value: @@ -61834,11 +62496,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &477 + '302': &472 description: Found - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61858,8 +62520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *330 - - *331 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61869,9 +62531,9 @@ paths: responses: '204': description: Response - '403': *436 + '403': *431 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61897,8 +62559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -61907,7 +62569,7 @@ paths: type: object additionalProperties: false properties: - language: &444 + language: &439 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +62648,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &448 + schema: &443 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61996,7 +62658,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *444 + query_language: *439 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +62705,7 @@ paths: items: type: object properties: - repository: &445 + repository: &440 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +62741,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &449 + analysis_status: &444 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +62773,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &446 + access_mismatch_repos: &441 type: object properties: repository_count: @@ -62125,7 +62787,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *445 + items: *440 required: - repository_count - repositories @@ -62147,8 +62809,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *446 - over_limit_repos: *446 + no_codeql_db_repos: *441 + over_limit_repos: *441 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +62826,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &447 + value: &442 summary: Default response value: id: 1 @@ -62316,17 +62978,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *447 + value: *442 repository_lists: summary: Response for a successful variant analysis submission - value: *447 + value: *442 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62347,8 +63009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *330 - - *331 + - *325 + - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,11 +63022,11 @@ paths: description: Response content: application/json: - schema: *448 + schema: *443 examples: - default: *447 + default: *442 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62385,7 +63047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *330 + - *325 - name: repo in: path description: The name of the controller repository. @@ -62420,7 +63082,7 @@ paths: type: object properties: repository: *53 - analysis_status: *449 + analysis_status: *444 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62524,7 +63186,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62545,8 +63207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -62631,9 +63293,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62652,8 +63314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -62720,7 +63382,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -62745,7 +63407,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *436 + '403': *431 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62759,7 +63421,7 @@ paths: content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62816,8 +63478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -62825,7 +63487,7 @@ paths: schema: type: object properties: - commit_sha: *450 + commit_sha: *445 ref: type: string description: |- @@ -62883,7 +63545,7 @@ paths: schema: type: object properties: - id: *441 + id: *436 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,11 +63559,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *436 + '403': *431 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62920,8 +63582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *330 - - *331 + - *325 + - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,10 +63629,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *430 + '403': *425 '404': description: Not Found if the sarif id does not match any upload - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62992,8 +63654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63049,7 +63711,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *163 + '204': *172 '304': *37 '403': *29 '404': *6 @@ -63074,8 +63736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +63857,8 @@ paths: parameters: - *17 - *19 - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63212,7 +63874,7 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: default: value: @@ -63488,7 +64150,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -63510,8 +64172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -63574,22 +64236,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63613,8 +64275,8 @@ paths: parameters: - *17 - *19 - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63654,7 +64316,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *106 + '500': *105 '400': *14 '401': *25 '403': *29 @@ -63678,8 +64340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +64376,14 @@ paths: type: integer machines: type: array - items: &661 + items: &666 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *452 - required: *453 + properties: *447 + required: *448 examples: - default: &662 + default: &667 value: total_count: 2 machines: @@ -63738,7 +64400,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -63761,8 +64423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +64508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63892,7 +64554,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63913,8 +64575,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -63932,7 +64594,7 @@ paths: type: integer secrets: type: array - items: &457 + items: &452 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,9 +64614,9 @@ paths: - created_at - updated_at examples: - default: *454 + default: *449 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63975,16 +64637,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *455 + schema: *450 examples: - default: *456 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +64666,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: *458 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,9 +64696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -64064,7 +64726,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -64088,9 +64750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -64118,8 +64780,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *330 - - *331 + - *325 + - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +64823,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &459 + properties: &454 login: type: string example: octocat @@ -64254,7 +64916,7 @@ paths: user_view_type: type: string example: public - required: &460 + required: &455 - avatar_url - events_url - followers_url @@ -64303,7 +64965,7 @@ paths: admin: false role_name: write headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -64328,9 +64990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '204': description: Response if user is a collaborator @@ -64376,9 +65038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 requestBody: required: false content: @@ -64404,7 +65066,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &526 + schema: &521 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64415,7 +65077,7 @@ paths: example: 42 type: integer format: int64 - repository: *137 + repository: *142 invitee: title: Simple User description: A GitHub user. @@ -64633,9 +65295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '204': description: No Content when collaborator was removed from the repository. @@ -64666,9 +65328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '200': description: if user has admin permissions @@ -64688,8 +65350,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *459 - required: *460 + properties: *454 + required: *455 nullable: true required: - permission @@ -64744,8 +65406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -64755,7 +65417,7 @@ paths: application/json: schema: type: array - items: &461 + items: &456 title: Commit Comment description: Commit Comment type: object @@ -64796,8 +65458,8 @@ paths: updated_at: type: string format: date-time - author_association: *72 - reactions: *73 + author_association: *71 + reactions: *72 required: - url - html_url @@ -64813,7 +65475,7 @@ paths: - created_at - updated_at examples: - default: &464 + default: &459 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64847,7 +65509,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64872,17 +65534,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *461 + schema: *456 examples: - default: &465 + default: &460 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,9 +65601,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -64963,7 +65625,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -65014,9 +65676,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -65037,9 +65699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -65065,11 +65727,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -65088,9 +65750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -65122,16 +65784,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -65153,10 +65815,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -65205,8 +65867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *330 - - *331 + - *325 + - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +65924,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: &575 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65334,8 +65996,8 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *58 - '500': *106 + Link: *54 + '500': *105 '400': *14 '404': *6 '409': *47 @@ -65358,9 +66020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *330 - - *331 - - &463 + - *325 + - *326 + - &458 name: commit_sha description: The SHA of the commit. in: path @@ -65432,9 +66094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -65444,11 +66106,11 @@ paths: application/json: schema: type: array - items: *461 + items: *456 examples: - default: *464 + default: *459 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65474,9 +66136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 requestBody: required: true content: @@ -65511,9 +66173,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: - default: *465 + default: *460 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +66203,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -65553,9 +66215,9 @@ paths: application/json: schema: type: array - items: *466 + items: *461 examples: - default: &567 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66034,7 +66696,7 @@ paths: auto_merge: draft: false headers: - Link: *58 + Link: *54 '409': *47 x-github: githubCloudOnly: false @@ -66092,11 +66754,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 - - &467 + - &462 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +66773,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: - default: &554 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66199,8 +66861,8 @@ paths: ..... '422': *15 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 '409': *47 x-github: githubCloudOnly: false @@ -66226,11 +66888,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *330 - - *331 - - *467 - - *468 - - *469 + - *325 + - *326 + - *462 + - *463 + - *464 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,11 +66926,11 @@ paths: type: integer check_runs: type: array - items: *411 + items: *406 examples: - default: *470 + default: *465 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66291,9 +66953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +66963,7 @@ paths: schema: type: integer example: 1 - - *468 + - *463 - *17 - *19 responses: @@ -66319,7 +66981,7 @@ paths: type: integer check_suites: type: array - items: *416 + items: *411 examples: default: value: @@ -66494,7 +67156,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66519,9 +67181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - *17 - *19 responses: @@ -66588,7 +67250,7 @@ paths: type: string total_count: type: integer - repository: *137 + repository: *142 commit_url: type: string format: uri @@ -66719,9 +67381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - *17 - *19 responses: @@ -66731,7 +67393,7 @@ paths: application/json: schema: type: array - items: &632 + items: &637 title: Status description: The status of a commit. type: object @@ -66811,8 +67473,8 @@ paths: type: User site_admin: false headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +67502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -66870,20 +67532,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *471 - required: *472 + properties: *466 + required: *467 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &473 + properties: &468 url: type: string format: uri html_url: type: string format: uri - required: &474 + required: &469 - url - html_url nullable: true @@ -66891,32 +67553,32 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true contributing: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true readme: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true issue_template: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true pull_request_template: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true required: - code_of_conduct @@ -67043,8 +67705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 - name: basehead @@ -67087,8 +67749,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *462 - merge_base_commit: *462 + base_commit: *457 + merge_base_commit: *457 status: type: string enum: @@ -67108,10 +67770,10 @@ paths: example: 6 commits: type: array - items: *462 + items: *457 files: type: array - items: *475 + items: *470 required: - url - html_url @@ -67354,8 +68016,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67397,8 +68059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -67541,7 +68203,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &476 + response-if-content-is-a-file: &471 summary: Response if content is a file value: type: file @@ -67673,7 +68335,7 @@ paths: - size - type - url - - &580 + - &577 title: Content File description: Content File type: object @@ -67874,7 +68536,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *476 + response-if-content-is-a-file: *471 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +68605,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *477 + '302': *472 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +68628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -68060,7 +68722,7 @@ paths: description: Response content: application/json: - schema: &478 + schema: &473 title: File Commit description: File Commit type: object @@ -68212,7 +68874,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: example-for-creating-a-file: value: @@ -68266,7 +68928,7 @@ paths: schema: oneOf: - *3 - - &508 + - &503 description: Repository rule violation was detected type: object properties: @@ -68287,7 +68949,7 @@ paths: items: type: object properties: - placeholder_id: &624 + placeholder_id: &629 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +68981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -68381,7 +69043,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -68416,7 +69078,7 @@ paths: '422': *15 '404': *6 '409': *47 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68436,8 +69098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *330 - - *331 + - *325 + - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68537,7 +69199,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *58 + Link: *54 '204': description: Response if repository is empty '403': *29 @@ -68560,31 +69222,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *330 - - *331 - - *170 - - *171 - - *172 - - *173 + - *325 + - *326 + - *179 + - *180 + - *181 + - *182 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *174 - - *479 - - *175 - - *176 + - *183 + - *474 + - *184 + - *185 - *48 - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -68595,8 +69249,6 @@ paths: default: 30 - *40 - *41 - - *177 - - *178 responses: '200': description: Response @@ -68604,11 +69256,11 @@ paths: application/json: schema: type: array - items: &482 + items: &477 type: object description: A Dependabot alert. properties: - number: *54 + number: *158 state: type: string description: The state of the Dependabot alert. @@ -68650,13 +69302,13 @@ paths: - unknown - direct - transitive - security_advisory: *480 + security_advisory: *475 security_vulnerability: *52 - url: *56 - html_url: *57 - created_at: *55 - updated_at: *153 - dismissed_at: *155 + url: *161 + html_url: *162 + created_at: *159 + updated_at: *160 + dismissed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -68680,8 +69332,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *154 - auto_dismissed_at: *481 + fixed_at: *163 + auto_dismissed_at: *476 required: - number - state @@ -68911,9 +69563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *330 - - *331 - - &483 + - *325 + - *326 + - &478 name: alert_number in: path description: |- @@ -68922,13 +69574,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *54 + schema: *158 responses: '200': description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69041,9 +69693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *330 - - *331 - - *483 + - *325 + - *326 + - *478 requestBody: required: true content: @@ -69088,7 +69740,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69217,8 +69869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -69236,7 +69888,7 @@ paths: type: integer secrets: type: array - items: &486 + items: &481 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69267,7 +69919,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69289,16 +69941,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *484 + schema: *479 examples: - default: *485 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69318,15 +69970,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *486 + schema: *481 examples: default: value: @@ -69352,9 +70004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -69382,7 +70034,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -69406,9 +70058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -69430,8 +70082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *330 - - *331 + - *325 + - *326 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -69567,7 +70219,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *58 + Link: *54 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -69591,8 +70243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -69808,7 +70460,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *58 + Link: *54 '404': *6 '403': *29 x-github: @@ -69831,8 +70483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -69907,7 +70559,7 @@ paths: - version - url additionalProperties: false - metadata: &487 + metadata: &482 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69940,7 +70592,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *487 + metadata: *482 resolved: type: object description: A collection of resolved package dependencies. @@ -69953,7 +70605,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *487 + metadata: *482 relationship: type: string description: A notation of whether a dependency is requested @@ -70082,8 +70734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *330 - - *331 + - *325 + - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -70123,11 +70775,11 @@ paths: application/json: schema: type: array - items: *488 + items: *483 examples: - default: *489 + default: *484 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70191,8 +70843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -70273,7 +70925,7 @@ paths: description: Response content: application/json: - schema: *488 + schema: *483 examples: simple-example: summary: Simple example @@ -70346,9 +70998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *330 - - *331 - - &490 + - *325 + - *326 + - &485 name: deployment_id description: deployment_id parameter in: path @@ -70360,7 +71012,7 @@ paths: description: Response content: application/json: - schema: *488 + schema: *483 examples: default: value: @@ -70425,9 +71077,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 responses: '204': description: Response @@ -70449,9 +71101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 - *17 - *19 responses: @@ -70461,7 +71113,7 @@ paths: application/json: schema: type: array - items: &491 + items: &486 title: Deployment Status description: The status of a deployment. type: object @@ -70552,8 +71204,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -70602,7 +71254,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -70622,9 +71274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 requestBody: required: true content: @@ -70699,9 +71351,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *486 examples: - default: &492 + default: &487 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70757,9 +71409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 - name: status_id in: path required: true @@ -70770,9 +71422,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *486 examples: - default: *492 + default: *487 '404': *6 x-github: githubCloudOnly: false @@ -70797,8 +71449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -70855,8 +71507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -70873,7 +71525,7 @@ paths: type: integer environments: type: array - items: &494 + items: &489 title: Environment description: Details of a deployment environment type: object @@ -70925,7 +71577,7 @@ paths: type: type: string example: wait_timer - wait_timer: &496 + wait_timer: &491 type: integer example: 30 description: The amount of time to delay a job after @@ -70962,11 +71614,11 @@ paths: items: type: object properties: - type: *493 + type: *488 reviewer: anyOf: - *4 - - *169 + - *178 required: - id - node_id @@ -70986,7 +71638,7 @@ paths: - id - node_id - type - deployment_branch_policy: &497 + deployment_branch_policy: &492 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71102,9 +71754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *330 - - *331 - - &495 + - *325 + - *326 + - &490 name: environment_name in: path required: true @@ -71117,9 +71769,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *489 examples: - default: &498 + default: &493 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71203,9 +71855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: false content: @@ -71214,7 +71866,7 @@ paths: type: object nullable: true properties: - wait_timer: *496 + wait_timer: *491 prevent_self_review: type: boolean example: false @@ -71231,13 +71883,13 @@ paths: items: type: object properties: - type: *493 + type: *488 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *497 + deployment_branch_policy: *492 additionalProperties: false examples: default: @@ -71257,9 +71909,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *489 examples: - default: *498 + default: *493 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71283,9 +71935,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 responses: '204': description: Default response @@ -71310,9 +71962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 - *17 - *19 responses: @@ -71330,7 +71982,7 @@ paths: example: 2 branch_policies: type: array - items: &499 + items: &494 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71387,9 +72039,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: true content: @@ -71435,9 +72087,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - example-wildcard: &500 + example-wildcard: &495 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71479,10 +72131,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - &501 + - *325 + - *326 + - *490 + - &496 name: branch_policy_id in: path required: true @@ -71494,9 +72146,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71515,10 +72167,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - *501 + - *325 + - *326 + - *490 + - *496 requestBody: required: true content: @@ -71546,9 +72198,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71567,10 +72219,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - *501 + - *325 + - *326 + - *490 + - *496 responses: '204': description: Response @@ -71595,9 +72247,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 responses: '200': description: List of deployment protection rules @@ -71613,7 +72265,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &502 + items: &497 title: Deployment protection rule description: Deployment protection rule type: object @@ -71632,7 +72284,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &503 + app: &498 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71731,9 +72383,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 requestBody: content: application/json: @@ -71754,9 +72406,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *502 + schema: *497 examples: - default: &504 + default: &499 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71791,9 +72443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 - *19 - *17 responses: @@ -71812,7 +72464,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *503 + items: *498 examples: default: value: @@ -71847,10 +72499,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *330 - - *331 - - *495 - - &505 + - *325 + - *326 + - *490 + - &500 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71862,9 +72514,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *497 examples: - default: *504 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71885,10 +72537,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *495 - - *331 - - *330 - - *505 + - *490 + - *326 + - *325 + - *500 responses: '204': description: Response @@ -71914,9 +72566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 - *17 - *19 responses: @@ -71934,11 +72586,11 @@ paths: type: integer secrets: type: array - items: *378 + items: *373 examples: - default: *379 + default: *374 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71961,17 +72613,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 responses: '200': description: Response content: application/json: - schema: *380 + schema: *375 examples: - default: *381 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71993,18 +72645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 responses: '200': description: Response content: application/json: - schema: *378 + schema: *373 examples: - default: *506 + default: *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72026,10 +72678,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 requestBody: required: true content: @@ -72060,7 +72712,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -72086,10 +72738,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 responses: '204': description: Default response @@ -72114,10 +72766,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *330 - - *331 - - *495 - - *349 + - *325 + - *326 + - *490 + - *344 - *19 responses: '200': @@ -72134,11 +72786,11 @@ paths: type: integer variables: type: array - items: *382 + items: *377 examples: - default: *383 + default: *378 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72159,9 +72811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: true content: @@ -72188,7 +72840,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -72213,18 +72865,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *330 - - *331 - - *495 - - *148 + - *325 + - *326 + - *490 + - *153 responses: '200': description: Response content: application/json: - schema: *382 + schema: *377 examples: - default: *507 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72245,10 +72897,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *330 - - *331 - - *148 - - *495 + - *325 + - *326 + - *153 + - *490 requestBody: required: true content: @@ -72290,10 +72942,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *330 - - *331 - - *148 - - *495 + - *325 + - *326 + - *153 + - *490 responses: '204': description: Response @@ -72315,8 +72967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -72326,7 +72978,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: 200-response: value: @@ -72384,8 +73036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *330 - - *331 + - *325 + - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72407,7 +73059,7 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: default: value: @@ -72520,7 +73172,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *58 + Link: *54 '400': *14 x-github: githubCloudOnly: false @@ -72544,8 +73196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -72577,9 +73229,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 '400': *14 '422': *15 '403': *29 @@ -72600,8 +73252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -72661,7 +73313,7 @@ paths: schema: oneOf: - *111 - - *508 + - *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72686,8 +73338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *330 - - *331 + - *325 + - *326 - name: file_sha in: path required: true @@ -72786,8 +73438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -72896,7 +73548,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &504 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73110,15 +73762,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 responses: '200': description: Response content: application/json: - schema: *509 + schema: *504 examples: default: value: @@ -73174,9 +73826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *330 - - *331 - - &510 + - *325 + - *326 + - &505 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -73193,7 +73845,7 @@ paths: application/json: schema: type: array - items: &511 + items: &506 title: Git Reference description: Git references within a repository type: object @@ -73246,7 +73898,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *58 + Link: *54 '409': *47 x-github: githubCloudOnly: false @@ -73268,17 +73920,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 responses: '200': description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: &512 + default: &507 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73307,8 +73959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73337,9 +73989,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: *512 + default: *507 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73365,9 +74017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 requestBody: required: true content: @@ -73396,9 +74048,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: *512 + default: *507 '422': *15 '409': *47 x-github: @@ -73416,9 +74068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 responses: '204': description: Response @@ -73473,8 +74125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73541,7 +74193,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &509 title: Git Tag description: Metadata for a Git tag type: object @@ -73592,7 +74244,7 @@ paths: - sha - type - url - verification: *513 + verification: *508 required: - sha - url @@ -73602,7 +74254,7 @@ paths: - tag - message examples: - default: &515 + default: &510 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73675,8 +74327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *330 - - *331 + - *325 + - *326 - name: tag_sha in: path required: true @@ -73687,9 +74339,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *509 examples: - default: *515 + default: *510 '404': *6 '409': *47 x-github: @@ -73713,8 +74365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73787,7 +74439,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &511 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73883,8 +74535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *330 - - *331 + - *325 + - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73907,7 +74559,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *511 examples: default-response: summary: Default response @@ -73966,8 +74618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -73977,7 +74629,7 @@ paths: application/json: schema: type: array - items: &517 + items: &512 title: Webhook description: Webhooks for repositories. type: object @@ -74031,7 +74683,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &747 + last_response: &751 title: Hook Response type: object properties: @@ -74086,7 +74738,7 @@ paths: status: unused message: headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -74105,8 +74757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -74158,9 +74810,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: &518 + default: &513 value: type: Repository id: 12345678 @@ -74208,17 +74860,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '200': description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: *518 + default: *513 '404': *6 x-github: githubCloudOnly: false @@ -74238,9 +74890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 requestBody: required: true content: @@ -74285,9 +74937,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: *518 + default: *513 '422': *15 '404': *6 x-github: @@ -74308,9 +74960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74334,9 +74986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '200': description: Response @@ -74363,9 +75015,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 requestBody: required: false content: @@ -74409,11 +75061,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *17 - - *187 + - *194 responses: '200': description: Response @@ -74421,9 +75073,9 @@ paths: application/json: schema: type: array - items: *188 + items: *195 examples: - default: *189 + default: *196 '400': *14 '422': *15 x-github: @@ -74442,18 +75094,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *197 examples: - default: *191 + default: *198 '400': *14 '422': *15 x-github: @@ -74472,9 +75124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *16 responses: '202': *39 @@ -74497,9 +75149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74524,9 +75176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74549,8 +75201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response if immutable releases are enabled @@ -74596,10 +75248,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '409': *47 x-github: githubCloudOnly: false @@ -74617,10 +75269,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '409': *47 x-github: githubCloudOnly: false @@ -74675,14 +75327,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &519 + schema: &514 title: Import description: A repository import from an external source. type: object @@ -74781,7 +75433,7 @@ paths: - html_url - authors_url examples: - default: &522 + default: &517 value: vcs: subversion use_lfs: true @@ -74797,7 +75449,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &520 + '503': &515 description: Unavailable due to service under maintenance. content: application/json: @@ -74826,8 +75478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -74875,7 +75527,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: default: value: @@ -74900,7 +75552,7 @@ paths: type: string '422': *15 '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74928,8 +75580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -74978,7 +75630,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: example-1: summary: Example 1 @@ -75026,7 +75678,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75049,12 +75701,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75080,9 +75732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *330 - - *331 - - &684 + - *325 + - *326 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75096,7 +75748,7 @@ paths: application/json: schema: type: array - items: &521 + items: &516 title: Porter Author description: Porter Author type: object @@ -75150,7 +75802,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75175,8 +75827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *330 - - *331 + - *325 + - *326 - name: author_id in: path required: true @@ -75206,7 +75858,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *516 examples: default: value: @@ -75219,7 +75871,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75243,8 +75895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75285,7 +75937,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75313,8 +75965,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -75341,11 +75993,11 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: - default: *522 + default: *517 '422': *15 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75368,8 +76020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75377,8 +76029,8 @@ paths: application/json: schema: *22 examples: - default: *523 - '301': *339 + default: *518 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -75398,8 +76050,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75407,12 +76059,12 @@ paths: application/json: schema: anyOf: - - *204 + - *211 - type: object properties: {} additionalProperties: false examples: - default: &525 + default: &520 value: limit: collaborators_only origin: repository @@ -75437,13 +76089,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *524 + schema: *519 examples: default: summary: Example request body @@ -75455,9 +76107,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: - default: *525 + default: *520 '409': description: Response x-github: @@ -75479,8 +76131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -75503,8 +76155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -75514,9 +76166,9 @@ paths: application/json: schema: type: array - items: *526 + items: *521 examples: - default: &677 + default: &681 value: - id: 1 repository: @@ -75630,7 +76282,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75647,9 +76299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *330 - - *331 - - *208 + - *325 + - *326 + - *215 requestBody: required: false content: @@ -75678,7 +76330,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *521 examples: default: value: @@ -75809,9 +76461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *330 - - *331 - - *208 + - *325 + - *326 + - *215 responses: '204': description: Response @@ -75842,8 +76494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *330 - - *331 + - *325 + - *326 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -75891,7 +76543,7 @@ paths: required: false schema: type: string - - *212 + - *219 - name: sort description: What to sort results by. in: query @@ -75904,7 +76556,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -75914,9 +76566,9 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: &535 + default: &530 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76063,8 +76715,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '422': *15 '404': *6 x-github: @@ -76093,8 +76745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -76176,9 +76828,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: &532 + default: &527 value: id: 1 node_id: MDU6SXNzdWUx @@ -76332,9 +76984,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *77 + '503': *106 '404': *6 - '410': *336 + '410': *331 x-github: triggersNotification: true githubCloudOnly: false @@ -76362,9 +77014,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *330 - - *331 - - *96 + - *325 + - *326 + - *94 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -76374,7 +77026,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -76384,9 +77036,9 @@ paths: application/json: schema: type: array - items: *527 + items: *522 examples: - default: &534 + default: &529 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76417,7 +77069,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '422': *15 '404': *6 x-github: @@ -76444,17 +77096,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: &528 + default: &523 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76508,9 +77160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -76532,9 +77184,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -76552,9 +77204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -76574,9 +77226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -76602,11 +77254,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -76625,9 +77277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -76659,16 +77311,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -76690,10 +77342,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -76713,8 +77365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -76724,7 +77376,7 @@ paths: application/json: schema: type: array - items: &531 + items: &526 title: Issue Event description: Issue Event type: object @@ -76767,8 +77419,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *529 - required: *530 + properties: *524 + required: *525 nullable: true label: title: Issue Event Label @@ -76812,7 +77464,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *169 + requested_team: *178 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76877,7 +77529,7 @@ paths: required: - from - to - author_association: *72 + author_association: *71 lock_reason: type: string nullable: true @@ -76890,8 +77542,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -77057,7 +77709,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -77075,8 +77727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *330 - - *331 + - *325 + - *326 - name: event_id in: path required: true @@ -77087,7 +77739,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *526 examples: default: value: @@ -77280,7 +77932,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *336 + '410': *331 '403': *29 x-github: githubCloudOnly: false @@ -77314,9 +77966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *330 - - *331 - - &533 + - *325 + - *326 + - &528 name: issue_number description: The number that identifies the issue. in: path @@ -77328,12 +77980,12 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '404': *6 - '410': *336 + '410': *331 '304': *37 x-github: githubCloudOnly: false @@ -77358,9 +78010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -77464,15 +78116,15 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 '422': *15 - '503': *77 + '503': *106 '403': *29 - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77490,9 +78142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -77518,9 +78170,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77536,9 +78188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: content: application/json: @@ -77563,9 +78215,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77587,9 +78239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: assignee in: path required: true @@ -77629,10 +78281,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *330 - - *331 - - *533 - - *79 + - *325 + - *326 + - *528 + - *77 - *17 - *19 responses: @@ -77642,13 +78294,13 @@ paths: application/json: schema: type: array - items: *527 + items: *522 examples: - default: *534 + default: *529 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77677,9 +78329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -77701,16 +78353,16 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -77738,9 +78390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77750,14 +78402,14 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77785,9 +78437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -77809,17 +78461,17 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *339 + '301': *334 '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -77850,9 +78502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77864,15 +78516,15 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 x-github: triggersNotification: true githubCloudOnly: false @@ -77898,9 +78550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77910,14 +78562,14 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77934,9 +78586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77950,7 +78602,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &537 + - &532 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77981,8 +78633,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 label: type: object properties: @@ -78004,7 +78656,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &533 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78035,8 +78687,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 label: type: object properties: @@ -78124,8 +78776,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 assigner: *4 required: @@ -78140,7 +78792,7 @@ paths: - performed_via_github_app - assignee - assigner - - &539 + - &534 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78171,8 +78823,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 milestone: type: object properties: @@ -78191,7 +78843,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &535 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78222,8 +78874,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 milestone: type: object properties: @@ -78242,7 +78894,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &536 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78273,8 +78925,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 rename: type: object properties: @@ -78296,7 +78948,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &537 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78327,10 +78979,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 review_requester: *4 - requested_team: *169 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -78343,7 +78995,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &538 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78374,10 +79026,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 review_requester: *4 - requested_team: *169 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -78390,7 +79042,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &539 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78421,8 +79073,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 dismissed_review: type: object properties: @@ -78450,7 +79102,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &540 title: Locked Issue Event description: Locked Issue Event type: object @@ -78481,8 +79133,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 lock_reason: type: string example: '"off-topic"' @@ -78498,7 +79150,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &541 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78529,8 +79181,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78564,7 +79216,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &542 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78595,8 +79247,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78630,7 +79282,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &548 + - &543 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78661,8 +79313,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78696,7 +79348,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &549 + - &544 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78786,8 +79438,8 @@ paths: name: label color: red headers: - Link: *58 - '410': *336 + Link: *54 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78804,9 +79456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -78816,9 +79468,9 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: &536 + default: &531 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78835,10 +79487,10 @@ paths: color: a2eeef default: false headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78855,9 +79507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -78916,12 +79568,12 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 - '301': *339 + default: *531 + '301': *334 '404': *6 - '410': *336 + '410': *331 '422': *15 x-github: githubCloudOnly: false @@ -78938,9 +79590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -79000,12 +79652,12 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 - '301': *339 + default: *531 + '301': *334 '404': *6 - '410': *336 + '410': *331 '422': *15 x-github: githubCloudOnly: false @@ -79022,15 +79674,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '204': description: Response - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79049,9 +79701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: name in: path required: true @@ -79064,7 +79716,7 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: default: value: @@ -79075,9 +79727,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79097,9 +79749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -79127,7 +79779,7 @@ paths: '204': description: Response '403': *29 - '410': *336 + '410': *331 '404': *6 '422': *15 x-github: @@ -79145,9 +79797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '204': description: Response @@ -79177,20 +79829,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '200': description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79207,9 +79859,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -79235,13 +79887,13 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79259,9 +79911,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79293,16 +79945,16 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -79324,10 +79976,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *330 - - *331 - - *533 + - *325 - *326 + - *528 + - *321 responses: '204': description: Response @@ -79356,9 +80008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79380,9 +80032,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79415,9 +80067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -79427,13 +80079,13 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79461,9 +80113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79490,16 +80142,16 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -79519,9 +80171,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79552,13 +80204,13 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 '403': *29 '404': *6 '422': *7 - '503': *77 + '503': *106 x-github: triggersNotification: true githubCloudOnly: false @@ -79576,9 +80228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -79593,6 +80245,11 @@ paths: description: Timeline Event type: object anyOf: + - *532 + - *533 + - *534 + - *535 + - *536 - *537 - *538 - *539 @@ -79601,11 +80258,6 @@ paths: - *542 - *543 - *544 - - *545 - - *546 - - *547 - - *548 - - *549 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79648,7 +80300,7 @@ paths: issue_url: type: string format: uri - author_association: *72 + author_association: *71 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -79658,9 +80310,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - event - actor @@ -79691,7 +80343,7 @@ paths: properties: type: type: string - issue: *71 + issue: *70 required: - event - created_at @@ -79891,7 +80543,7 @@ paths: type: string body_text: type: string - author_association: *72 + author_association: *71 required: - event - id @@ -79914,7 +80566,7 @@ paths: type: string comments: type: array - items: &569 + items: &566 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80003,7 +80655,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *72 + author_association: *71 _links: type: object properties: @@ -80087,7 +80739,7 @@ paths: enum: - line - file - reactions: *73 + reactions: *72 body_html: type: string example: '"

comment body

"' @@ -80123,7 +80775,7 @@ paths: type: string comments: type: array - items: *461 + items: *456 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80154,8 +80806,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 required: - id @@ -80198,8 +80850,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 required: - id @@ -80242,8 +80894,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 state_reason: type: string nullable: true @@ -80410,9 +81062,9 @@ paths: type: User site_admin: true headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80429,8 +81081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -80440,7 +81092,7 @@ paths: application/json: schema: type: array - items: &550 + items: &545 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80490,7 +81142,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80506,8 +81158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -80543,9 +81195,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *545 examples: - default: &551 + default: &546 value: id: 1 key: ssh-rsa AAA... @@ -80579,9 +81231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *330 - - *331 - - &552 + - *325 + - *326 + - &547 name: key_id description: The unique identifier of the key. in: path @@ -80593,9 +81245,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *545 examples: - default: *551 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80613,9 +81265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *330 - - *331 - - *552 + - *325 + - *326 + - *547 responses: '204': description: Response @@ -80635,8 +81287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -80646,11 +81298,11 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 + default: *531 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -80669,8 +81321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -80706,9 +81358,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: - default: &553 + default: &548 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80740,8 +81392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80752,9 +81404,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: - default: *553 + default: *548 '404': *6 x-github: githubCloudOnly: false @@ -80771,8 +81423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80811,7 +81463,7 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: default: value: @@ -80837,8 +81489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80864,8 +81516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -80904,9 +81556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *330 - - *331 - - *437 + - *325 + - *326 + - *432 responses: '200': description: Response @@ -80968,8 +81620,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true required: - _links @@ -81051,8 +81703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81117,8 +81769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81152,9 +81804,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *462 + schema: *457 examples: - default: *554 + default: *549 '204': description: Response when already merged '404': @@ -81179,8 +81831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81221,12 +81873,12 @@ paths: application/json: schema: type: array - items: &555 + items: &550 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 examples: default: value: @@ -81265,7 +81917,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -81282,8 +81934,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81323,9 +81975,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: &556 + default: &551 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81384,9 +82036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *330 - - *331 - - &557 + - *325 + - *326 + - &552 name: milestone_number description: The number that identifies the milestone. in: path @@ -81398,9 +82050,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: *556 + default: *551 '404': *6 x-github: githubCloudOnly: false @@ -81417,9 +82069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 requestBody: required: false content: @@ -81457,9 +82109,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: *556 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81475,9 +82127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 responses: '204': description: Response @@ -81498,9 +82150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 - *17 - *19 responses: @@ -81510,11 +82162,11 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 + default: *531 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81531,12 +82183,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *330 - - *331 - - *558 - - *559 - - *79 - - *560 + - *325 + - *326 + - *553 + - *554 + - *77 + - *555 - *17 - *19 responses: @@ -81546,11 +82198,11 @@ paths: application/json: schema: type: array - items: *99 + items: *97 examples: - default: *561 + default: *556 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81572,8 +82224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -81631,14 +82283,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &562 + schema: &557 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81763,7 +82415,7 @@ paths: - custom_404 - public examples: - default: &563 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81804,8 +82456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81859,9 +82511,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: *563 + default: *558 '422': *15 '409': *47 x-github: @@ -81884,8 +82536,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81984,8 +82636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -82011,8 +82663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -82022,7 +82674,7 @@ paths: application/json: schema: type: array - items: &564 + items: &559 title: Page Build description: Page Build type: object @@ -82097,7 +82749,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82116,8 +82768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response @@ -82162,16 +82814,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *564 + schema: *559 examples: - default: &565 + default: &560 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82219,8 +82871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *330 - - *331 + - *325 + - *326 - name: build_id in: path required: true @@ -82231,9 +82883,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *559 examples: - default: *565 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82253,8 +82905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82359,9 +83011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *330 - - *331 - - &566 + - *325 + - *326 + - &561 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82419,11 +83071,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *330 - - *331 - - *566 + - *325 + - *326 + - *561 responses: - '204': *163 + '204': *172 '404': *6 x-github: githubCloudOnly: false @@ -82448,8 +83100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -82680,7 +83332,7 @@ paths: description: Empty response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -82707,8 +83359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Private vulnerability reporting status @@ -82745,10 +83397,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '422': *14 x-github: githubCloudOnly: false @@ -82767,10 +83419,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '422': *14 x-github: githubCloudOnly: false @@ -82791,8 +83443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: Indicates the state of the projects to return. in: query @@ -82813,7 +83465,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -82849,11 +83501,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *58 + Link: *54 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -82876,8 +83528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82903,13 +83555,13 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *335 + default: *330 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -82932,8 +83584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -82941,16 +83593,9 @@ paths: application/json: schema: type: array - items: *262 + items: *104 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *562 '403': *29 '404': *6 x-github: @@ -82972,8 +83617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82985,19 +83630,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *262 + items: *104 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *563 responses: '204': description: No Content when custom property values are successfully created @@ -83035,8 +83672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -83096,11 +83733,11 @@ paths: application/json: schema: type: array - items: *466 + items: *461 examples: - default: *567 + default: *564 headers: - Link: *58 + Link: *54 '304': *37 '422': *15 x-github: @@ -83130,8 +83767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -83196,7 +83833,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &568 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83307,8 +83944,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true active_lock_reason: type: string @@ -83353,7 +83990,7 @@ paths: nullable: true requested_teams: type: array - items: *308 + items: *303 nullable: true head: type: object @@ -83362,7 +83999,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: *4 @@ -83379,7 +84016,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: *4 @@ -83392,14 +84029,14 @@ paths: _links: type: object properties: - comments: *252 - commits: *252 - statuses: *252 - html: *252 - issue: *252 - review_comments: *252 - review_comment: *252 - self: *252 + comments: *258 + commits: *258 + statuses: *258 + html: *258 + issue: *258 + review_comments: *258 + review_comment: *258 + self: *258 required: - comments - commits @@ -83409,8 +84046,8 @@ paths: - review_comments - review_comment - self - author_association: *72 - auto_merge: *568 + author_association: *71 + auto_merge: *565 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83502,7 +84139,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &569 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -84029,8 +84666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: sort in: query required: false @@ -84049,7 +84686,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -84059,9 +84696,9 @@ paths: application/json: schema: type: array - items: *569 + items: *566 examples: - default: &574 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84113,7 +84750,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84138,17 +84775,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *569 + schema: *566 examples: - default: &570 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84223,9 +84860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -84247,9 +84884,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: - default: *570 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84265,9 +84902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -84288,9 +84925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -84316,11 +84953,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -84339,9 +84976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -84373,16 +85010,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -84404,10 +85041,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -84450,9 +85087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *330 - - *331 - - &573 + - *325 + - *326 + - &570 name: pull_number description: The number that identifies the pull request. in: path @@ -84465,9 +85102,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *568 examples: - default: *572 + default: *569 '304': *37 '404': *6 '406': @@ -84475,8 +85112,8 @@ paths: content: application/json: schema: *3 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84502,9 +85139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -84546,9 +85183,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *568 examples: - default: *572 + default: *569 '422': *15 '403': *29 x-github: @@ -84570,9 +85207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -84632,21 +85269,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84672,10 +85309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *330 - - *331 - - *573 - - *96 + - *325 + - *326 + - *570 + - *94 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -84685,7 +85322,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -84695,11 +85332,11 @@ paths: application/json: schema: type: array - items: *569 + items: *566 examples: - default: *574 + default: *571 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84730,9 +85367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -84837,7 +85474,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: example-for-a-multi-line-comment: value: @@ -84925,10 +85562,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *330 - - *331 - - *573 - - *88 + - *325 + - *326 + - *570 + - *86 requestBody: required: true content: @@ -84950,7 +85587,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: default: value: @@ -85036,9 +85673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -85048,11 +85685,11 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: *575 + default: *572 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85080,9 +85717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -85092,7 +85729,7 @@ paths: application/json: schema: type: array - items: *475 + items: *470 examples: default: value: @@ -85108,10 +85745,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *58 + Link: *54 '422': *15 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85130,9 +85767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 responses: '204': description: Response if pull request has been merged @@ -85155,9 +85792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -85268,9 +85905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 responses: '200': description: Response @@ -85286,7 +85923,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 required: - users - teams @@ -85327,7 +85964,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85345,9 +85982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -85384,7 +86021,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *461 examples: default: value: @@ -85920,9 +86557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -85956,7 +86593,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *461 examples: default: value: @@ -86461,9 +87098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -86473,7 +87110,7 @@ paths: application/json: schema: type: array - items: &576 + items: &573 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86542,7 +87179,7 @@ paths: type: string body_text: type: string - author_association: *72 + author_association: *71 required: - id - node_id @@ -86591,7 +87228,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86624,9 +87261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -86712,9 +87349,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: &578 + default: &575 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86777,10 +87414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - &577 + - *325 + - *326 + - *570 + - &574 name: review_id description: The unique identifier of the review. in: path @@ -86792,9 +87429,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: &579 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86853,10 +87490,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -86879,7 +87516,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: default: value: @@ -86941,18 +87578,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 responses: '200': description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *578 + default: *575 '422': *7 '404': *6 x-github: @@ -86979,10 +87616,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 - *17 - *19 responses: @@ -87061,13 +87698,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *72 + author_association: *71 _links: type: object properties: - self: *252 - html: *252 - pull_request: *252 + self: *258 + html: *258 + pull_request: *258 required: - self - html @@ -87076,7 +87713,7 @@ paths: type: string body_html: type: string - reactions: *73 + reactions: *72 side: description: The side of the first line of the range for a multi-line comment. @@ -87188,7 +87825,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -87217,10 +87854,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -87248,7 +87885,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: default: value: @@ -87311,10 +87948,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -87349,9 +87986,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *579 + default: *576 '404': *6 '422': *7 '403': *29 @@ -87373,9 +88010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -87438,8 +88075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87452,9 +88089,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: - default: &581 + default: &578 value: type: file encoding: base64 @@ -87496,8 +88133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *330 - - *331 + - *325 + - *326 - name: dir description: The alternate path to look for a README file in: path @@ -87517,9 +88154,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: - default: *581 + default: *578 '404': *6 '422': *15 x-github: @@ -87541,8 +88178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -87552,7 +88189,7 @@ paths: application/json: schema: type: array - items: *582 + items: *579 examples: default: value: @@ -87626,7 +88263,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -87646,8 +88283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -87723,9 +88360,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: &586 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87830,9 +88467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *330 - - *331 - - &584 + - *325 + - *326 + - &581 name: asset_id description: The unique identifier of the asset. in: path @@ -87844,9 +88481,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *580 examples: - default: &585 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87881,7 +88518,7 @@ paths: type: User site_admin: false '404': *6 - '302': *477 + '302': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87897,9 +88534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *330 - - *331 - - *584 + - *325 + - *326 + - *581 requestBody: required: false content: @@ -87927,9 +88564,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *580 examples: - default: *585 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87945,9 +88582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *330 - - *331 - - *584 + - *325 + - *326 + - *581 responses: '204': description: Response @@ -87971,8 +88608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -88057,16 +88694,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88083,8 +88720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *330 - - *331 + - *325 + - *326 - name: tag description: tag parameter in: path @@ -88097,9 +88734,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -88121,9 +88758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *330 - - *331 - - &587 + - *325 + - *326 + - &584 name: release_id description: The unique identifier of the release. in: path @@ -88137,9 +88774,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '401': description: Unauthorized x-github: @@ -88157,9 +88794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 requestBody: required: false content: @@ -88223,9 +88860,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '404': description: Not Found if the discussion category name is invalid content: @@ -88246,9 +88883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 responses: '204': description: Response @@ -88268,9 +88905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - *17 - *19 responses: @@ -88280,7 +88917,7 @@ paths: application/json: schema: type: array - items: *583 + items: *580 examples: default: value: @@ -88317,7 +88954,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88361,9 +88998,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - name: name in: query required: true @@ -88389,7 +89026,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *580 examples: response-for-successful-upload: value: @@ -88444,9 +89081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88470,11 +89107,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -88493,9 +89130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 requestBody: required: true content: @@ -88525,16 +89162,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -88556,10 +89193,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *330 - - *331 - - *587 + - *325 - *326 + - *584 + - *321 responses: '204': description: Response @@ -88583,9 +89220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 - *17 - *19 responses: @@ -88601,8 +89238,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *271 - - &588 + - *276 + - &585 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88621,69 +89258,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *272 - - *588 - - allOf: - - *273 - - *588 - - allOf: - - *274 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *275 - - *588 - - allOf: - - *276 - - *588 - allOf: - *277 - - *588 + - *585 - allOf: - *278 - - *588 + - *585 - allOf: - *279 - - *588 + - *585 + - allOf: + - *586 + - *585 - allOf: - *280 - - *588 + - *585 - allOf: - *281 - - *588 + - *585 - allOf: - *282 - - *588 + - *585 - allOf: - *283 - - *588 + - *585 - allOf: - *284 - - *588 + - *585 - allOf: - *285 - - *588 + - *585 - allOf: - *286 - - *588 + - *585 - allOf: - *287 - - *588 + - *585 - allOf: - *288 - - *588 + - *585 - allOf: - *289 - - *588 + - *585 - allOf: - *290 - - *588 + - *585 + - allOf: + - *291 + - *585 + - allOf: + - *292 + - *585 + - allOf: + - *293 + - *585 - allOf: - - *590 - - *588 + - *294 + - *585 + - allOf: + - *295 + - *585 + - allOf: + - *587 + - *585 examples: default: value: @@ -88722,8 +89359,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - name: includes_parents @@ -88734,7 +89371,7 @@ paths: schema: type: boolean default: true - - *591 + - *588 responses: '200': description: Response @@ -88742,7 +89379,7 @@ paths: application/json: schema: type: array - items: *291 + items: *296 examples: default: value: @@ -88773,7 +89410,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -88789,8 +89426,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 requestBody: description: Request body required: true @@ -88810,16 +89447,16 @@ paths: - tag - push default: branch - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *266 + items: *274 + conditions: *271 rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *589 required: - name - enforcement @@ -88850,9 +89487,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &602 + default: &599 value: id: 42 name: super cool ruleset @@ -88885,7 +89522,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -88899,12 +89536,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *330 - - *331 + - *325 + - *326 + - *590 + - *591 + - *592 - *593 - - *594 - - *595 - - *596 - *17 - *19 responses: @@ -88912,11 +89549,11 @@ paths: description: Response content: application/json: - schema: *597 + schema: *594 examples: - default: *598 + default: *595 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88935,19 +89572,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *330 - - *331 - - *599 + - *325 + - *326 + - *596 responses: '200': description: Response content: application/json: - schema: *600 + schema: *597 examples: - default: *601 + default: *598 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88973,8 +89610,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -88994,11 +89631,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *602 + default: *599 '404': *6 - '500': *106 + '500': *105 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -89014,8 +89651,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89040,16 +89677,16 @@ paths: - branch - tag - push - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *266 + items: *274 + conditions: *271 rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *589 examples: default: value: @@ -89077,11 +89714,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *602 + default: *599 '404': *6 - '500': *106 + '500': *105 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -89097,8 +89734,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89109,7 +89746,7 @@ paths: '204': description: Response '404': *6 - '500': *106 + '500': *105 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -89121,8 +89758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - name: ruleset_id @@ -89138,11 +89775,11 @@ paths: application/json: schema: type: array - items: *294 + items: *299 examples: - default: *603 + default: *600 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89159,8 +89796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89178,7 +89815,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *601 examples: default: value: @@ -89211,7 +89848,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89233,21 +89870,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *330 - - *331 - - *295 - - *296 - - *297 - - *298 + - *325 + - *326 + - *602 + - *603 + - *604 + - *605 - *48 - *19 - *17 - - *605 - *606 - - *299 - - *300 - - *301 - - *302 + - *607 + - *608 + - *609 + - *610 + - *611 responses: '200': description: Response @@ -89255,11 +89892,11 @@ paths: application/json: schema: type: array - items: &610 + items: &615 type: object properties: - number: *54 - created_at: *55 + number: *158 + created_at: *159 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89267,15 +89904,15 @@ paths: format: date-time readOnly: true nullable: true - url: *56 - html_url: *57 + url: *161 + html_url: *162 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *607 - resolution: *608 + state: *612 + resolution: *613 resolved_at: type: string format: date-time @@ -89371,7 +90008,7 @@ paths: pull request. ' - oneOf: *609 + oneOf: *614 nullable: true has_more_locations: type: boolean @@ -89498,7 +90135,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89520,16 +90157,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 - - *302 + - *325 + - *326 + - *426 + - *611 responses: '200': description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -89560,7 +90197,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89581,9 +90218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: true content: @@ -89591,8 +90228,8 @@ paths: schema: type: object properties: - state: *607 - resolution: *608 + state: *612 + resolution: *613 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -89610,7 +90247,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -89663,7 +90300,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89685,9 +90322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 - *19 - *17 responses: @@ -89698,7 +90335,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &769 + items: &773 type: object properties: type: @@ -89724,11 +90361,6 @@ paths: example: commit details: oneOf: - - *611 - - *612 - - *613 - - *614 - - *615 - *616 - *617 - *618 @@ -89737,6 +90369,11 @@ paths: - *621 - *622 - *623 + - *624 + - *625 + - *626 + - *627 + - *628 examples: default: value: @@ -89796,11 +90433,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *58 + Link: *54 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89822,8 +90459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -89831,14 +90468,14 @@ paths: schema: type: object properties: - reason: &625 + reason: &630 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *624 + placeholder_id: *629 required: - reason - placeholder_id @@ -89855,7 +90492,7 @@ paths: schema: type: object properties: - reason: *625 + reason: *630 expire_at: type: string format: date-time @@ -89878,7 +90515,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89890,6 +90527,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -89898,13 +90538,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *77 + '503': *106 '200': description: Response content: @@ -89914,7 +90554,7 @@ paths: properties: incremental_scans: type: array - items: &626 + items: &631 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89940,15 +90580,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *626 + items: *631 backfill_scans: type: array - items: *626 + items: *631 custom_pattern_backfill_scans: type: array items: allOf: - - *626 + - *631 - type: object properties: pattern_name: @@ -90018,8 +90658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *330 - - *331 + - *325 + - *326 - *48 - name: sort description: The property to sort the results by. @@ -90063,9 +90703,9 @@ paths: application/json: schema: type: array - items: *627 + items: *632 examples: - default: *628 + default: *633 '400': *14 '404': *6 x-github: @@ -90088,8 +90728,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -90162,7 +90802,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 required: - login - type @@ -90249,9 +90889,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: &630 + default: &635 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90484,8 +91124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -90589,7 +91229,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: default: value: @@ -90736,17 +91376,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '200': description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: *630 + default: *635 '403': *29 '404': *6 x-github: @@ -90770,9 +91410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 requestBody: required: true content: @@ -90845,7 +91485,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 required: - login - type @@ -90931,10 +91571,10 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: *630 - add_credit: *630 + default: *635 + add_credit: *635 '403': *29 '404': *6 '422': @@ -90972,9 +91612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '202': *39 '400': *14 @@ -91001,17 +91641,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '202': description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 '400': *14 '422': *15 '403': *29 @@ -91037,8 +91677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91115,7 +91755,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -91137,8 +91777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91147,7 +91787,7 @@ paths: application/json: schema: type: array - items: &631 + items: &636 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91160,7 +91800,7 @@ paths: - 1124 - -435 '202': *39 - '204': *163 + '204': *172 '422': description: Repository contains more than 10,000 commits x-github: @@ -91180,8 +91820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91230,7 +91870,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91257,8 +91897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91332,7 +91972,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91354,8 +91994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91509,8 +92149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91520,7 +92160,7 @@ paths: application/json: schema: type: array - items: *631 + items: *636 examples: default: value: @@ -91533,7 +92173,7 @@ paths: - - 0 - 2 - 21 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91553,8 +92193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *330 - - *331 + - *325 + - *326 - name: sha in: path required: true @@ -91608,7 +92248,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *637 examples: default: value: @@ -91662,8 +92302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91675,9 +92315,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91695,14 +92335,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &633 + schema: &638 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91770,8 +92410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -91797,7 +92437,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *638 examples: default: value: @@ -91824,8 +92464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -91845,8 +92485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91902,7 +92542,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91925,8 +92565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91934,7 +92574,7 @@ paths: application/json: schema: type: array - items: &634 + items: &639 title: Tag protection description: Tag protection type: object @@ -91986,8 +92626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92010,7 +92650,7 @@ paths: description: Response content: application/json: - schema: *634 + schema: *639 examples: default: value: @@ -92041,8 +92681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92079,8 +92719,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *330 - - *331 + - *325 + - *326 - name: ref in: path required: true @@ -92116,8 +92756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -92127,11 +92767,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -92149,8 +92789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 responses: @@ -92158,7 +92798,7 @@ paths: description: Response content: application/json: - schema: &635 + schema: &640 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92170,7 +92810,7 @@ paths: required: - names examples: - default: &636 + default: &641 value: names: - octocat @@ -92193,8 +92833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92225,9 +92865,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *640 examples: - default: *636 + default: *641 '404': *6 '422': *7 x-github: @@ -92248,9 +92888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *330 - - *331 - - &637 + - *325 + - *326 + - &642 name: per description: The time frame to display results for. in: query @@ -92279,7 +92919,7 @@ paths: example: 128 clones: type: array - items: &638 + items: &643 title: Traffic type: object properties: @@ -92366,8 +93006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -92457,8 +93097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -92518,9 +93158,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *330 - - *331 - - *637 + - *325 + - *326 + - *642 responses: '200': description: Response @@ -92539,7 +93179,7 @@ paths: example: 3782 views: type: array - items: *638 + items: *643 required: - uniques - count @@ -92616,8 +93256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92653,7 +93293,7 @@ paths: description: Response content: application/json: - schema: *137 + schema: *142 examples: default: value: @@ -92891,8 +93531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92915,8 +93555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -92938,8 +93578,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -92965,8 +93605,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *330 - - *331 + - *325 + - *326 - name: ref in: path required: true @@ -93058,9 +93698,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93101,7 +93741,7 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: default: value: @@ -93290,7 +93930,7 @@ paths: html_url: type: string format: uri - repository: *137 + repository: *142 score: type: number file_size: @@ -93308,7 +93948,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &639 + text_matches: &644 title: Search Result Text Matches type: array items: @@ -93422,7 +94062,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *77 + '503': *106 '422': *15 '403': *29 x-github: @@ -93470,7 +94110,7 @@ paths: enum: - author-date - committer-date - - &640 + - &645 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93541,7 +94181,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true comment_count: type: integer @@ -93561,7 +94201,7 @@ paths: url: type: string format: uri - verification: *513 + verification: *508 required: - author - committer @@ -93580,7 +94220,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true parents: type: array @@ -93593,12 +94233,12 @@ paths: type: string sha: type: string - repository: *137 + repository: *142 score: type: number node_id: type: string - text_matches: *639 + text_matches: *644 required: - sha - node_id @@ -93790,7 +94430,7 @@ paths: - interactions - created - updated - - *640 + - *645 - *17 - *19 - name: advanced_search @@ -93887,11 +94527,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: type: string state_reason: @@ -93908,8 +94548,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true comments: type: integer @@ -93923,7 +94563,7 @@ paths: type: string format: date-time nullable: true - text_matches: *639 + text_matches: *644 pull_request: type: object properties: @@ -93956,10 +94596,10 @@ paths: type: string score: type: number - author_association: *72 + author_association: *71 draft: type: boolean - repository: *67 + repository: *66 body_html: type: string body_text: @@ -93967,7 +94607,7 @@ paths: timeline_url: type: string format: uri - type: *209 + type: *216 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -93977,9 +94617,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - assignee - closed_at @@ -94095,7 +94735,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *77 + '503': *106 '422': *15 '304': *37 '403': *29 @@ -94148,7 +94788,7 @@ paths: enum: - created - updated - - *640 + - *645 - *17 - *19 responses: @@ -94192,7 +94832,7 @@ paths: nullable: true score: type: number - text_matches: *639 + text_matches: *644 required: - id - node_id @@ -94277,7 +94917,7 @@ paths: - forks - help-wanted-issues - updated - - *640 + - *645 - *17 - *19 responses: @@ -94496,8 +95136,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true permissions: type: object @@ -94516,7 +95156,7 @@ paths: - admin - pull - push - text_matches: *639 + text_matches: *644 temp_clone_token: type: string allow_merge_commit: @@ -94718,7 +95358,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *77 + '503': *106 '422': *15 '304': *37 x-github: @@ -94816,7 +95456,7 @@ paths: type: string format: uri nullable: true - text_matches: *639 + text_matches: *644 related: type: array nullable: true @@ -95007,7 +95647,7 @@ paths: - followers - repositories - joined - - *640 + - *645 - *17 - *19 responses: @@ -95111,7 +95751,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *639 + text_matches: *644 blog: type: string nullable: true @@ -95170,7 +95810,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *77 + '503': *106 '422': *15 x-github: githubCloudOnly: false @@ -95190,7 +95830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &644 + - &649 name: team_id description: The unique identifier of the team. in: path @@ -95202,9 +95842,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 x-github: githubCloudOnly: false @@ -95231,7 +95871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *644 + - *649 requestBody: required: true content: @@ -95294,16 +95934,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '201': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 '422': *15 '403': *29 @@ -95331,7 +95971,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *644 + - *649 responses: '204': description: Response @@ -95362,7 +96002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *644 + - *649 - *48 - *17 - *19 @@ -95373,11 +96013,11 @@ paths: application/json: schema: type: array - items: *317 + items: *312 examples: - default: *645 + default: *650 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95404,7 +96044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *644 + - *649 requestBody: required: true content: @@ -95438,9 +96078,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: triggersNotification: true githubCloudOnly: false @@ -95467,16 +96107,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 responses: '200': description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95501,8 +96141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: false content: @@ -95525,9 +96165,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *646 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95552,8 +96192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 responses: '204': description: Response @@ -95582,8 +96222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *644 - - *319 + - *649 + - *314 - *48 - *17 - *19 @@ -95594,11 +96234,11 @@ paths: application/json: schema: type: array - items: *320 + items: *315 examples: - default: *647 + default: *652 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95625,8 +96265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: true content: @@ -95648,9 +96288,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: triggersNotification: true githubCloudOnly: false @@ -95677,17 +96317,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 responses: '200': description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95712,9 +96352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 requestBody: required: true content: @@ -95736,9 +96376,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *648 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95763,9 +96403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 responses: '204': description: Response @@ -95794,9 +96434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -95822,11 +96462,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95853,9 +96493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 requestBody: required: true content: @@ -95887,9 +96527,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95915,8 +96555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -95942,11 +96582,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95973,8 +96613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: true content: @@ -96006,9 +96646,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96032,7 +96672,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96042,11 +96682,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96070,7 +96710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *644 + - *649 - name: role description: Filters members returned by their role in the team. in: query @@ -96093,9 +96733,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96121,8 +96761,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: if user is a member @@ -96158,8 +96798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96198,8 +96838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96235,16 +96875,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '200': description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-user-is-a-team-maintainer: *649 + response-if-user-is-a-team-maintainer: *654 '404': *6 x-github: githubCloudOnly: false @@ -96277,8 +96917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 requestBody: required: false content: @@ -96303,9 +96943,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-users-membership-with-team-is-now-pending: *650 + response-if-users-membership-with-team-is-now-pending: *655 '403': description: Forbidden if team synchronization is set up '422': @@ -96339,8 +96979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96368,7 +97008,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96378,11 +97018,11 @@ paths: application/json: schema: type: array - items: *328 + items: *323 examples: - default: *651 + default: *656 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96406,16 +97046,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *644 - - *329 + - *649 + - *324 responses: '200': description: Response content: application/json: - schema: *328 + schema: *323 examples: - default: *652 + default: *657 '404': description: Not Found if project is not managed by this team x-github: @@ -96439,8 +97079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *644 - - *329 + - *649 + - *324 requestBody: required: false content: @@ -96507,8 +97147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *644 - - *329 + - *649 + - *324 responses: '204': description: Response @@ -96535,7 +97175,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96545,11 +97185,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96577,15 +97217,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *653 + schema: *658 examples: alternative-response-with-extra-repository-information: value: @@ -96736,9 +97376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 requestBody: required: false content: @@ -96788,9 +97428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 responses: '204': description: Response @@ -96815,7 +97455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96825,11 +97465,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - response-if-child-teams-exist: *654 + response-if-child-teams-exist: *659 headers: - Link: *58 + Link: *54 '404': *6 '403': *29 '422': *15 @@ -96860,7 +97500,7 @@ paths: application/json: schema: oneOf: - - &656 + - &661 title: Private User description: Private User type: object @@ -97063,7 +97703,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *655 + - *660 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97216,7 +97856,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *661 examples: default: value: @@ -97295,7 +97935,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '304': *37 '404': *6 '403': *29 @@ -97318,7 +97958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *63 + - *59 responses: '204': description: If the user is blocked @@ -97346,7 +97986,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -97370,7 +98010,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -97419,11 +98059,11 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: - default: *215 + default: *222 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -97560,21 +98200,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97614,7 +98254,7 @@ paths: type: integer secrets: type: array - items: &657 + items: &662 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97654,9 +98294,9 @@ paths: - visibility - selected_repositories_url examples: - default: *454 + default: *449 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97724,13 +98364,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 responses: '200': description: Response content: application/json: - schema: *657 + schema: *662 examples: default: value: @@ -97760,7 +98400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 requestBody: required: true content: @@ -97805,7 +98445,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -97833,7 +98473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 responses: '204': description: Response @@ -97858,7 +98498,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *145 + - *150 responses: '200': description: Response @@ -97874,13 +98514,13 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *658 + default: *663 '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97901,7 +98541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *145 + - *150 requestBody: required: true content: @@ -97933,7 +98573,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97955,7 +98595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *145 + - *150 - name: repository_id in: path required: true @@ -97967,7 +98607,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97988,7 +98628,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *145 + - *150 - name: repository_id in: path required: true @@ -98000,7 +98640,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98020,17 +98660,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98054,7 +98694,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 requestBody: required: false content: @@ -98084,9 +98724,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 @@ -98108,11 +98748,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '202': *39 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98137,13 +98777,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '202': description: Response content: application/json: - schema: &659 + schema: &664 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98184,7 +98824,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &660 + default: &665 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98192,7 +98832,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98216,7 +98856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *216 + - *223 - name: export_id in: path required: true @@ -98229,9 +98869,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *664 examples: - default: *660 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -98252,7 +98892,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *216 + - *223 responses: '200': description: Response @@ -98268,11 +98908,11 @@ paths: type: integer machines: type: array - items: *661 + items: *666 examples: - default: *662 + default: *667 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98299,7 +98939,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *216 + - *223 requestBody: required: true content: @@ -98349,13 +98989,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *338 + repository: *333 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *452 - required: *453 + properties: *447 + required: *448 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99129,17 +99769,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '304': *37 - '500': *106 + '500': *105 '400': *14 '401': *25 '402': @@ -99169,16 +99809,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 - '500': *106 + default: *446 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -99207,9 +99847,9 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: &674 + default: &678 value: - id: 197 name: hello_docker @@ -99310,7 +99950,7 @@ paths: application/json: schema: type: array - items: &663 + items: &668 title: Email description: Email type: object @@ -99375,16 +100015,16 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: - default: &676 + default: &680 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -99452,7 +100092,7 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: default: value: @@ -99562,9 +100202,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -99595,9 +100235,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -99617,7 +100257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *63 + - *59 responses: '204': description: if the person is followed by the authenticated user @@ -99647,7 +100287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -99672,7 +100312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -99708,7 +100348,7 @@ paths: application/json: schema: type: array - items: &664 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -99839,7 +100479,7 @@ paths: - subkeys - revoked examples: - default: &690 + default: &694 value: - id: 3 name: Octocat's GPG Key @@ -99871,7 +100511,7 @@ paths: revoked: false raw_key: string headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -99924,9 +100564,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *669 examples: - default: &665 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -99983,7 +100623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &666 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -99995,9 +100635,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *669 examples: - default: *665 + default: *670 '404': *6 '304': *37 '403': *29 @@ -100020,7 +100660,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *666 + - *671 responses: '204': description: Response @@ -100163,7 +100803,7 @@ paths: suspended_at: suspended_by: headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -100209,11 +100849,11 @@ paths: type: string repositories: type: array - items: *67 + items: *66 examples: - default: *129 + default: *134 headers: - Link: *58 + Link: *54 '404': *6 '403': *29 '304': *37 @@ -100236,7 +100876,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *126 + - *131 responses: '204': description: Response @@ -100262,7 +100902,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *126 + - *131 responses: '204': description: Response @@ -100296,12 +100936,12 @@ paths: application/json: schema: anyOf: - - *204 + - *211 - type: object properties: {} additionalProperties: false examples: - default: *205 + default: *212 '204': description: Response when there are no restrictions x-github: @@ -100325,7 +100965,7 @@ paths: required: true content: application/json: - schema: *524 + schema: *519 examples: default: value: @@ -100336,7 +100976,7 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: default: value: @@ -100417,7 +101057,7 @@ paths: - closed - all default: open - - *212 + - *219 - name: sort description: What to sort results by. in: query @@ -100430,7 +101070,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -100440,11 +101080,11 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *213 + default: *220 headers: - Link: *58 + Link: *54 '404': *6 '304': *37 x-github: @@ -100475,7 +101115,7 @@ paths: application/json: schema: type: array - items: &667 + items: &672 title: Key description: Key type: object @@ -100526,7 +101166,7 @@ paths: verified: false read_only: false headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -100576,9 +101216,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *672 examples: - default: &668 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100611,15 +101251,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *552 + - *547 responses: '200': description: Response content: application/json: - schema: *667 + schema: *672 examples: - default: *668 + default: *673 '404': *6 '304': *37 '403': *29 @@ -100642,7 +101282,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *552 + - *547 responses: '204': description: Response @@ -100675,7 +101315,7 @@ paths: application/json: schema: type: array - items: &669 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100732,7 +101372,7 @@ paths: - id - type - login - plan: *90 + plan: *88 required: - billing_cycle - next_billing_date @@ -100743,7 +101383,7 @@ paths: - account - plan examples: - default: &670 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100776,7 +101416,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '304': *37 '401': *25 '404': *6 @@ -100805,11 +101445,11 @@ paths: application/json: schema: type: array - items: *669 + items: *674 examples: - default: *670 + default: *675 headers: - Link: *58 + Link: *54 '304': *37 '401': *25 x-github: @@ -100847,7 +101487,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -100924,7 +101564,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -100949,13 +101589,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -101013,7 +101653,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *105 + - *63 requestBody: required: true content: @@ -101038,7 +101678,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -101106,7 +101746,7 @@ paths: application/json: schema: type: array - items: *221 + items: *227 examples: default: value: @@ -101259,7 +101899,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -101359,7 +101999,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -101539,7 +102179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *222 + - *228 - name: exclude in: query required: false @@ -101552,7 +102192,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -101746,7 +102386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *222 + - *228 responses: '302': description: Response @@ -101772,7 +102412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *222 + - *228 responses: '204': description: Response @@ -101801,8 +102441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *222 - - *671 + - *228 + - *676 responses: '204': description: Response @@ -101826,7 +102466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *222 + - *228 - *17 - *19 responses: @@ -101836,11 +102476,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -101873,11 +102513,11 @@ paths: application/json: schema: type: array - items: *218 + items: *61 examples: - default: *672 + default: *101 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -101917,7 +102557,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *19 - *17 responses: @@ -101927,10 +102567,10 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 - '400': *675 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101950,16 +102590,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: - default: &691 + default: &695 value: id: 40201 name: octo-name @@ -102072,8 +102712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 responses: '204': description: Response @@ -102103,8 +102743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 - name: token description: package token schema: @@ -102136,8 +102776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 - *19 - *17 - name: state @@ -102157,7 +102797,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -102206,15 +102846,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -102250,9 +102890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '204': description: Response @@ -102282,9 +102922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '204': description: Response @@ -102340,7 +102980,7 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: default: value: @@ -102412,11 +103052,11 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: - default: *676 + default: *680 headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -102525,9 +103165,9 @@ paths: application/json: schema: type: array - items: *67 + items: *66 examples: - default: &683 + default: &687 summary: Default response value: - id: 1296269 @@ -102648,7 +103288,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '403': *29 @@ -102831,9 +103471,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102871,11 +103511,11 @@ paths: application/json: schema: type: array - items: *526 + items: *521 examples: - default: *677 + default: *681 headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -102896,7 +103536,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *208 + - *215 responses: '204': description: Response @@ -102919,7 +103559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *208 + - *215 responses: '204': description: Response @@ -102952,7 +103592,7 @@ paths: application/json: schema: type: array - items: &678 + items: &682 title: Social account description: Social media account type: object @@ -102967,12 +103607,12 @@ paths: - provider - url examples: - default: &679 + default: &683 value: - provider: twitter url: https://twitter.com/github headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103029,9 +103669,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 '422': *15 '304': *37 '404': *6 @@ -103118,7 +103758,7 @@ paths: application/json: schema: type: array - items: &680 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103138,7 +103778,7 @@ paths: - title - created_at examples: - default: &705 + default: &709 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103151,7 +103791,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103204,9 +103844,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: &681 + default: &685 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103237,7 +103877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &682 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103249,9 +103889,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: *681 + default: *685 '404': *6 '304': *37 '403': *29 @@ -103274,7 +103914,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *682 + - *686 responses: '204': description: Response @@ -103303,7 +103943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &706 + - &710 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -103326,13 +103966,13 @@ paths: application/json: schema: type: array - items: *67 + items: *66 examples: - default-response: *683 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &707 + items: &711 title: Starred Repository description: Starred Repository type: object @@ -103340,7 +103980,7 @@ paths: starred_at: type: string format: date-time - repo: *67 + repo: *66 required: - starred_at - repo @@ -103468,7 +104108,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -103488,8 +104128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response if this repository is starred by you @@ -103517,8 +104157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -103542,8 +104182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -103576,11 +104216,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -103615,7 +104255,7 @@ paths: application/json: schema: type: array - items: *315 + items: *310 examples: default: value: @@ -103666,7 +104306,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103693,7 +104333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *92 + - *90 responses: '200': description: Response @@ -103701,10 +104341,10 @@ paths: application/json: schema: oneOf: - - *656 - - *655 + - *661 + - *660 examples: - default-response: &685 + default-response: &689 summary: Default response value: login: octocat @@ -103739,7 +104379,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &686 + response-with-git-hub-plan-information: &690 summary: Response with GitHub plan information value: login: octocat @@ -103799,7 +104439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *684 + - *688 - *17 responses: '200': @@ -103810,7 +104450,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: Link: example: ; rel="next" @@ -103840,7 +104480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *63 + - *59 responses: '200': description: Response @@ -103848,11 +104488,11 @@ paths: application/json: schema: oneOf: - - *656 - - *655 + - *661 + - *660 examples: - default-response: *685 - response-with-git-hub-plan-information: *686 + default-response: *689 + response-with-git-hub-plan-information: *690 '404': *6 x-github: githubCloudOnly: false @@ -103878,7 +104518,7 @@ paths: - *17 - *40 - *41 - - *63 + - *59 requestBody: required: true content: @@ -103901,8 +104541,8 @@ paths: required: - subject_digests examples: - default: *687 - withPredicateType: *688 + default: *691 + withPredicateType: *692 responses: '200': description: Response @@ -103955,7 +104595,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *689 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103973,7 +104613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *63 + - *59 requestBody: required: true content: @@ -104038,7 +104678,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *63 + - *59 - name: subject_digest description: Subject Digest in: path @@ -104069,7 +104709,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *63 + - *59 - name: attestation_id description: Attestation ID in: path @@ -104107,7 +104747,7 @@ paths: - *17 - *40 - *41 - - *63 + - *59 - name: subject_digest description: Subject Digest in: path @@ -104159,12 +104799,12 @@ paths: initiator: type: string examples: - default: *394 + default: *389 '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -104190,7 +104830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *63 + - *59 responses: '200': description: Response @@ -104198,9 +104838,9 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 + default: *678 '403': *29 '401': *25 x-github: @@ -104223,7 +104863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104233,7 +104873,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104295,8 +104935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: + - *59 - *63 - - *105 - *17 - *19 responses: @@ -104306,7 +104946,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104383,7 +105023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104393,7 +105033,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104451,7 +105091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104463,9 +105103,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104482,7 +105122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104494,9 +105134,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104513,7 +105153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *63 + - *59 - name: target_user in: path required: true @@ -104540,8 +105180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *63 - - *79 + - *59 + - *77 - *17 - *19 responses: @@ -104551,11 +105191,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -104574,7 +105214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104584,11 +105224,11 @@ paths: application/json: schema: type: array - items: *664 + items: *669 examples: - default: *690 + default: *694 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104610,7 +105250,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *63 + - *59 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -104682,7 +105322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *63 + - *59 responses: '200': description: Response @@ -104690,7 +105330,7 @@ paths: application/json: schema: *22 examples: - default: *523 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104708,7 +105348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104743,7 +105383,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104763,7 +105403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104773,11 +105413,11 @@ paths: application/json: schema: type: array - items: *218 + items: *61 examples: - default: *672 + default: *101 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104814,8 +105454,8 @@ paths: - docker - nuget - container - - *673 - - *63 + - *677 + - *59 - *19 - *17 responses: @@ -104825,12 +105465,12 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 + default: *678 '403': *29 '401': *25 - '400': *675 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104850,17 +105490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: - default: *691 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104881,9 +105521,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '204': description: Response @@ -104915,9 +105555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 - name: token description: package token schema: @@ -104949,9 +105589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '200': description: Response @@ -104959,7 +105599,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -105017,16 +105657,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *230 - - *231 - - *233 - - *63 + - *236 + - *237 + - *239 + - *59 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -105061,10 +105701,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *230 - - *231 - - *63 - - *233 + - *236 + - *237 + - *59 + - *239 responses: '204': description: Response @@ -105096,10 +105736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *230 - - *231 - - *63 - - *233 + - *236 + - *237 + - *59 + - *239 responses: '204': description: Response @@ -105125,7 +105765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *63 + - *59 - name: state description: Indicates the state of the projects to return. in: query @@ -105146,7 +105786,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -105182,7 +105822,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -105204,7 +105844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *63 + - *59 - name: q description: Limit results to projects of the specified type. in: query @@ -105221,11 +105861,11 @@ paths: application/json: schema: type: array - items: *245 + items: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105245,18 +105885,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *247 - - *63 + - *253 + - *59 responses: '200': description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105276,8 +105916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *247 - - *63 + - *253 + - *59 - *17 - *40 - *41 @@ -105288,11 +105928,11 @@ paths: application/json: schema: type: array - items: *248 + items: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105312,19 +105952,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *247 - - *692 - - *63 + - *253 + - *696 + - *59 responses: '200': description: Response content: application/json: - schema: *248 + schema: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105345,8 +105985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *247 - - *63 + - *253 + - *59 - *40 - *41 - *17 @@ -105358,16 +105998,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -105375,11 +106018,11 @@ paths: application/json: schema: type: array - items: *255 + items: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105398,8 +106041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *63 - - *247 + - *59 + - *253 requestBody: required: true description: Details of the item to add to the project. @@ -105436,10 +106079,10 @@ paths: description: Response content: application/json: - schema: *693 + schema: *697 examples: - issue: *254 - pull_request: *254 + issue: *260 + pull_request: *260 '304': *37 '403': *29 '401': *25 @@ -105459,30 +106102,33 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *255 + schema: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105501,9 +106147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -105573,13 +106219,13 @@ paths: description: Response content: application/json: - schema: *255 + schema: *261 examples: - text_field: *256 - number_field: *256 - date_field: *256 - single_select_field: *256 - iteration_field: *256 + text_field: *262 + number_field: *262 + date_field: *262 + single_select_field: *262 + iteration_field: *262 '401': *25 '403': *29 '404': *6 @@ -105599,9 +106245,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 responses: '204': description: Response @@ -105628,7 +106274,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -105638,7 +106284,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -105703,7 +106349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -105713,7 +106359,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -105776,7 +106422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *63 + - *59 - name: type description: Limit results to repositories of the specified type. in: query @@ -105819,11 +106465,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105845,15 +106491,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *694 + schema: *698 examples: - default: *695 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105875,15 +106521,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *696 + schema: *700 examples: - default: *697 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105892,7 +106538,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -105900,12 +106549,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - - *63 + - *59 - *107 - - *698 + - *702 - *108 - - *699 - - *700 + - *703 + - *704 responses: '200': description: Response when getting a billing premium request usage report @@ -105958,19 +106607,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -106012,8 +106661,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106035,15 +106684,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *701 + schema: *705 examples: - default: *702 + default: *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106063,11 +106712,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *63 + - *59 - *107 - - *703 + - *707 - *108 - - *704 + - *708 responses: '200': description: Response when getting a billing usage report @@ -106137,8 +106786,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106156,7 +106805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106166,11 +106815,11 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106188,7 +106837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106198,11 +106847,11 @@ paths: application/json: schema: type: array - items: *680 + items: *684 examples: - default: *705 + default: *709 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106224,8 +106873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *63 - - *706 + - *59 + - *710 - *48 - *17 - *19 @@ -106237,13 +106886,13 @@ paths: schema: anyOf: - type: array - items: *707 + items: *711 - type: array - items: *67 + items: *66 examples: - default-response: *683 + default-response: *687 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106260,7 +106909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106270,11 +106919,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106400,7 +107049,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &708 + enterprise: &712 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106458,7 +107107,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &709 + installation: &713 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106477,7 +107126,7 @@ x-webhooks: required: - id - node_id - organization: &710 + organization: &714 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106537,13 +107186,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &711 + repository: &715 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &741 + properties: &745 id: description: Unique identifier of the repository example: 42 @@ -106563,8 +107212,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true organization: title: Simple User @@ -107226,7 +107875,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &742 + required: &746 - archive_url - assignees_url - blobs_url @@ -107377,10 +108026,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -107456,11 +108105,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: &712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: &716 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -107683,11 +108332,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: *712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: *716 sender: *4 required: - action @@ -107870,11 +108519,11 @@ x-webhooks: - everyone required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: *712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: *716 sender: *4 required: - action @@ -107958,7 +108607,7 @@ x-webhooks: type: string enum: - completed - check_run: &714 + check_run: &718 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108011,8 +108660,8 @@ x-webhooks: type: string pull_requests: type: array - items: *76 - repository: *137 + items: *75 + repository: *142 status: example: completed type: string @@ -108049,7 +108698,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *713 + deployment: *717 details_url: example: https://example.com type: string @@ -108099,7 +108748,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *76 + items: *75 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108134,10 +108783,10 @@ x-webhooks: - output - app - pull_requests - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -108530,11 +109179,11 @@ x-webhooks: type: string enum: - created - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -108930,11 +109579,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 requested_action: description: The action requested by the user. type: object @@ -109339,11 +109988,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -110320,10 +110969,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -110993,10 +111642,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -111660,10 +112309,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -111829,7 +112478,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111974,20 +112623,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &715 + commit_oid: &719 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *708 - installation: *709 - organization: *710 - ref: &716 + enterprise: *712 + installation: *713 + organization: *714 + ref: &720 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -112152,7 +112801,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112382,12 +113031,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -112482,7 +113131,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112653,12 +113302,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -112824,7 +113473,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112990,12 +113639,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -113095,7 +113744,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113263,16 +113912,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *711 + repository: *715 sender: *4 required: - action @@ -113369,7 +114018,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113509,12 +114158,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -113771,10 +114420,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -113854,18 +114503,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *710 - pusher_type: &717 + organization: *714 + pusher_type: &721 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &718 + ref: &722 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113875,7 +114524,7 @@ x-webhooks: enum: - tag - branch - repository: *711 + repository: *715 sender: *4 required: - ref @@ -113957,10 +114606,10 @@ x-webhooks: type: string enum: - created - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114045,9 +114694,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114124,10 +114773,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114204,10 +114853,10 @@ x-webhooks: type: string enum: - updated - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114284,19 +114933,19 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - repository: *711 - organization: *710 + enterprise: *712 + installation: *713 + repository: *715 + organization: *714 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *262 + items: *104 old_property_values: type: array description: The old custom property values for the repository. - items: *262 + items: *104 required: - action - repository @@ -114372,18 +115021,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - pusher_type: *717 - ref: *718 + enterprise: *712 + installation: *713 + organization: *714 + pusher_type: *721 + ref: *722 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *711 + repository: *715 sender: *4 required: - ref @@ -114467,11 +115116,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114555,11 +115204,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114643,11 +115292,11 @@ x-webhooks: type: string enum: - created - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114729,11 +115378,11 @@ x-webhooks: type: string enum: - dismissed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114815,11 +115464,11 @@ x-webhooks: type: string enum: - fixed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114902,11 +115551,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114988,11 +115637,11 @@ x-webhooks: type: string enum: - reopened - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -115069,9 +115718,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - key: &719 + enterprise: *712 + installation: *713 + key: &723 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115107,8 +115756,8 @@ x-webhooks: - verified - created_at - read_only - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -115185,11 +115834,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - key: *719 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + key: *723 + organization: *714 + repository: *715 sender: *4 required: - action @@ -115750,12 +116399,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: &723 + workflow: &727 title: Workflow type: object nullable: true @@ -116481,13 +117130,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *488 + deployment: *483 pull_requests: type: array - items: *571 - repository: *711 - organization: *710 - installation: *709 + items: *568 + repository: *715 + organization: *714 + installation: *713 sender: *4 responses: '200': @@ -116558,7 +117207,7 @@ x-webhooks: type: string enum: - approved - approver: &720 + approver: &724 type: object properties: avatar_url: @@ -116601,11 +117250,11 @@ x-webhooks: type: string comment: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - reviewers: &721 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + reviewers: &725 type: array items: type: object @@ -116684,7 +117333,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &722 + workflow_job_run: &726 type: object properties: conclusion: @@ -117415,18 +118064,18 @@ x-webhooks: type: string enum: - rejected - approver: *720 + approver: *724 comment: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - reviewers: *721 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + reviewers: *725 sender: *4 since: type: string - workflow_job_run: *722 + workflow_job_run: *726 workflow_job_runs: type: array items: @@ -118130,13 +118779,13 @@ x-webhooks: type: string enum: - requested - enterprise: *708 + enterprise: *712 environment: type: string - installation: *709 - organization: *710 - repository: *711 - requestor: &728 + installation: *713 + organization: *714 + repository: *715 + requestor: &732 title: User type: object nullable: true @@ -120035,12 +120684,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Deployment Workflow Run type: object @@ -120720,7 +121369,7 @@ x-webhooks: type: string enum: - answered - answer: &726 + answer: &730 type: object properties: author_association: @@ -120877,11 +121526,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121008,11 +121657,11 @@ x-webhooks: - from required: - category - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121095,11 +121744,11 @@ x-webhooks: type: string enum: - closed - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121181,7 +121830,7 @@ x-webhooks: type: string enum: - created - comment: &725 + comment: &729 type: object properties: author_association: @@ -121338,11 +121987,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121425,12 +122074,12 @@ x-webhooks: type: string enum: - deleted - comment: *725 - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + comment: *729 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121525,12 +122174,12 @@ x-webhooks: - from required: - body - comment: *725 - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + comment: *729 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121614,11 +122263,11 @@ x-webhooks: type: string enum: - created - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121700,11 +122349,11 @@ x-webhooks: type: string enum: - deleted - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121804,11 +122453,11 @@ x-webhooks: type: string required: - from - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121890,10 +122539,10 @@ x-webhooks: type: string enum: - labeled - discussion: *724 - enterprise: *708 - installation: *709 - label: &727 + discussion: *728 + enterprise: *712 + installation: *713 + label: &731 title: Label type: object properties: @@ -121925,8 +122574,8 @@ x-webhooks: - color - default - description - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122009,11 +122658,11 @@ x-webhooks: type: string enum: - locked - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122095,11 +122744,11 @@ x-webhooks: type: string enum: - pinned - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122181,11 +122830,11 @@ x-webhooks: type: string enum: - reopened - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122270,16 +122919,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *724 - new_repository: *711 + new_discussion: *728 + new_repository: *715 required: - new_discussion - new_repository - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122362,10 +123011,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *724 - old_answer: *726 - organization: *710 - repository: *711 + discussion: *728 + old_answer: *730 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122447,12 +123096,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *724 - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122535,11 +123184,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122621,11 +123270,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122698,7 +123347,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *708 + enterprise: *712 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123358,9 +124007,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *709 - organization: *710 - repository: *711 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - forkee @@ -123506,9 +124155,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pages: description: The pages that were updated. type: array @@ -123545,7 +124194,7 @@ x-webhooks: - action - sha - html_url - repository: *711 + repository: *715 sender: *4 required: - pages @@ -123621,10 +124270,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: &729 + organization: *714 + repositories: &733 description: An array of repository objects that the installation can access. type: array @@ -123650,8 +124299,8 @@ x-webhooks: - name - full_name - private - repository: *711 - requester: *728 + repository: *715 + requester: *732 sender: *4 required: - action @@ -123726,11 +124375,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -123806,11 +124455,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -123886,10 +124535,10 @@ x-webhooks: type: string enum: - added - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories_added: &730 + organization: *714 + repositories_added: &734 description: An array of repository objects, which were added to the installation. type: array @@ -123935,15 +124584,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *711 - repository_selection: &731 + repository: *715 + repository_selection: &735 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *728 + requester: *732 sender: *4 required: - action @@ -124022,10 +124671,10 @@ x-webhooks: type: string enum: - removed - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories_added: *730 + organization: *714 + repositories_added: *734 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124052,9 +124701,9 @@ x-webhooks: - name - full_name - private - repository: *711 - repository_selection: *731 - requester: *728 + repository: *715 + repository_selection: *735 + requester: *732 sender: *4 required: - action @@ -124133,11 +124782,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -124315,10 +124964,10 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 target_type: type: string @@ -124397,11 +125046,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -124525,8 +125174,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 reactions: title: Reactions type: object @@ -124653,8 +125302,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125448,8 +126097,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125465,7 +126114,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -125798,8 +126447,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -125879,7 +126528,7 @@ x-webhooks: type: string enum: - deleted - comment: &732 + comment: &736 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126044,8 +126693,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -126835,8 +127484,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126852,7 +127501,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -127187,8 +127836,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -127268,7 +127917,7 @@ x-webhooks: type: string enum: - edited - changes: &761 + changes: &765 description: The changes to the comment. type: object properties: @@ -127280,9 +127929,9 @@ x-webhooks: type: string required: - from - comment: *732 - enterprise: *708 - installation: *709 + comment: *736 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128075,8 +128724,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128092,7 +128741,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -128425,8 +129074,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128510,15 +129159,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 + blocked_issue: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - blocking_issue_repo: *67 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + blocking_issue_repo: *66 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128606,15 +129255,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 + blocked_issue: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - blocking_issue_repo: *67 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + blocking_issue_repo: *66 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128701,15 +129350,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 - blocked_issue_repo: *67 + blocked_issue: *70 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128797,15 +129446,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 - blocked_issue_repo: *67 + blocked_issue: *70 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128890,10 +129539,10 @@ x-webhooks: type: string enum: - assigned - assignee: *728 - enterprise: *708 - installation: *709 - issue: &735 + assignee: *732 + enterprise: *712 + installation: *713 + issue: &739 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -129682,11 +130331,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129702,7 +130351,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -129803,8 +130452,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -129884,8 +130533,8 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130679,11 +131328,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130699,7 +131348,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -130935,8 +131584,8 @@ x-webhooks: required: - state - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -131015,8 +131664,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131801,11 +132450,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131821,7 +132470,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -131921,8 +132570,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -132001,8 +132650,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132809,11 +133458,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132829,7 +133478,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -132908,7 +133557,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &733 + milestone: &737 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133046,8 +133695,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -133146,8 +133795,8 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133936,11 +134585,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133953,7 +134602,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -134057,9 +134706,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *727 - organization: *710 - repository: *711 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -134139,8 +134788,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134928,11 +135577,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134945,7 +135594,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -135049,9 +135698,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *727 - organization: *710 - repository: *711 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -135131,8 +135780,8 @@ x-webhooks: type: string enum: - locked - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135944,11 +136593,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135961,7 +136610,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -136042,8 +136691,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -136122,8 +136771,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136929,11 +137578,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136949,7 +137598,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -137027,9 +137676,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *733 - organization: *710 - repository: *711 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -137897,11 +138546,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137994,7 +138643,7 @@ x-webhooks: required: - login - id - type: *209 + type: *216 required: - id - number @@ -138463,8 +139112,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139253,11 +139902,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139273,7 +139922,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -139373,8 +140022,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -139454,9 +140103,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *708 - installation: *709 - issue: &734 + enterprise: *712 + installation: *713 + issue: &738 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140239,11 +140888,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140259,7 +140908,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -140359,8 +141008,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -140439,8 +141088,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141250,11 +141899,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141348,9 +141997,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *209 - organization: *710 - repository: *711 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142216,11 +142865,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142236,7 +142885,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -142804,11 +143453,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *708 - installation: *709 - issue: *734 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *738 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142888,12 +143537,12 @@ x-webhooks: type: string enum: - typed - enterprise: *708 - installation: *709 - issue: *735 - type: *209 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142974,7 +143623,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &764 + assignee: &768 title: User type: object nullable: true @@ -143044,11 +143693,11 @@ x-webhooks: required: - login - id - enterprise: *708 - installation: *709 - issue: *735 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + organization: *714 + repository: *715 sender: *4 required: - action @@ -143127,12 +143776,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *708 - installation: *709 - issue: *735 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -143212,8 +143861,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144023,11 +144672,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144043,7 +144692,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -144121,8 +144770,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144202,11 +144851,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *708 - installation: *709 - issue: *734 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *738 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144285,12 +144934,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *708 - installation: *709 - issue: *735 - type: *209 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144370,11 +145019,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144452,11 +145101,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144566,11 +145215,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144652,9 +145301,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: &736 + enterprise: *712 + installation: *713 + marketplace_purchase: &740 title: Marketplace Purchase type: object required: @@ -144737,8 +145386,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *710 - previous_marketplace_purchase: &737 + organization: *714 + previous_marketplace_purchase: &741 title: Marketplace Purchase type: object properties: @@ -144818,7 +145467,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -144898,10 +145547,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -144984,7 +145633,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -145066,10 +145715,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145151,7 +145800,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -145232,8 +145881,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 marketplace_purchase: title: Marketplace Purchase type: object @@ -145315,9 +145964,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *710 - previous_marketplace_purchase: *737 - repository: *711 + organization: *714 + previous_marketplace_purchase: *741 + repository: *715 sender: *4 required: - action @@ -145397,12 +146046,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 - previous_marketplace_purchase: *737 - repository: *711 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 + previous_marketplace_purchase: *741 + repository: *715 sender: *4 required: - action @@ -145504,11 +146153,11 @@ x-webhooks: type: string required: - to - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145608,11 +146257,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145691,11 +146340,11 @@ x-webhooks: type: string enum: - removed - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145773,11 +146422,11 @@ x-webhooks: type: string enum: - added - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 scope: description: The scope of the membership. Currently, can only be `team`. @@ -145853,7 +146502,7 @@ x-webhooks: required: - login - id - team: &738 + team: &742 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146076,11 +146725,11 @@ x-webhooks: type: string enum: - removed - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146157,7 +146806,7 @@ x-webhooks: required: - login - id - team: *738 + team: *742 required: - action - scope @@ -146239,8 +146888,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *709 - merge_group: &740 + installation: *713 + merge_group: &744 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146259,15 +146908,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *739 + head_commit: *743 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146353,10 +147002,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *709 - merge_group: *740 - organization: *710 - repository: *711 + installation: *713 + merge_group: *744 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146429,7 +147078,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 + enterprise: *712 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146538,16 +147187,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *709 - organization: *710 + installation: *713 + organization: *714 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -146628,11 +147277,11 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146711,9 +147360,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - milestone: &743 + enterprise: *712 + installation: *713 + milestone: &747 title: Milestone description: A collection of related issues and pull requests. type: object @@ -146850,8 +147499,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146930,11 +147579,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147044,11 +147693,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147128,11 +147777,11 @@ x-webhooks: type: string enum: - opened - enterprise: *708 - installation: *709 - milestone: *743 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *747 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147211,11 +147860,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *728 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + blocked_user: *732 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147294,11 +147943,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *728 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + blocked_user: *732 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147377,9 +148026,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - membership: &744 + enterprise: *712 + installation: *713 + membership: &748 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147486,8 +148135,8 @@ x-webhooks: - role - organization_url - user - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147565,11 +148214,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147648,8 +148297,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -147765,10 +148414,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 - user: *728 + user: *732 required: - action - invitation @@ -147846,11 +148495,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147937,11 +148586,11 @@ x-webhooks: properties: from: type: string - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -148017,9 +148666,9 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 package: description: Information about the package. type: object @@ -148518,7 +149167,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &745 + items: &749 title: Ruby Gems metadata type: object properties: @@ -148613,7 +149262,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -148689,9 +149338,9 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 package: description: Information about the package. type: object @@ -149044,7 +149693,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *745 + items: *749 source_url: type: string format: uri @@ -149114,7 +149763,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -149291,12 +149940,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *708 + enterprise: *712 id: type: integer - installation: *709 - organization: *710 - repository: *711 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - id @@ -149373,7 +150022,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &746 + personal_access_token_request: &750 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149519,10 +150168,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *708 - organization: *710 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149599,11 +150248,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *746 - enterprise: *708 - organization: *710 + personal_access_token_request: *750 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149679,11 +150328,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *746 - enterprise: *708 - organization: *710 + personal_access_token_request: *750 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149758,11 +150407,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *746 - organization: *710 - enterprise: *708 + personal_access_token_request: *750 + organization: *714 + enterprise: *712 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149867,7 +150516,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *747 + last_response: *751 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -149899,8 +150548,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 zen: description: Random string of GitHub zen. @@ -150145,10 +150794,10 @@ x-webhooks: - from required: - note - enterprise: *708 - installation: *709 - organization: *710 - project_card: &748 + enterprise: *712 + installation: *713 + organization: *714 + project_card: &752 title: Project Card type: object properties: @@ -150267,7 +150916,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -150348,11 +150997,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project_card: *748 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_card: *752 + repository: *715 sender: *4 required: - action @@ -150432,9 +151081,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 project_card: title: Project Card type: object @@ -150562,8 +151211,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -150657,11 +151306,11 @@ x-webhooks: - from required: - note - enterprise: *708 - installation: *709 - organization: *710 - project_card: *748 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_card: *752 + repository: *715 sender: *4 required: - action @@ -150755,9 +151404,9 @@ x-webhooks: - from required: - column_id - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 project_card: allOf: - title: Project Card @@ -150947,7 +151596,7 @@ x-webhooks: type: string required: - after_id - repository: *711 + repository: *715 sender: *4 required: - action @@ -151027,10 +151676,10 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - organization: *710 - project: &750 + enterprise: *712 + installation: *713 + organization: *714 + project: &754 title: Project type: object properties: @@ -151154,7 +151803,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -151234,10 +151883,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project_column: &749 + enterprise: *712 + installation: *713 + organization: *714 + project_column: &753 title: Project Column type: object properties: @@ -151276,7 +151925,7 @@ x-webhooks: - name - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -151355,18 +152004,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -151456,11 +152105,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 + repository: *715 sender: *4 required: - action @@ -151540,11 +152189,11 @@ x-webhooks: type: string enum: - moved - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 + repository: *715 sender: *4 required: - action @@ -151624,11 +152273,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151708,18 +152357,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - project: *750 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -151821,11 +152470,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151904,11 +152553,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151989,9 +152638,9 @@ x-webhooks: type: string enum: - closed - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152072,9 +152721,9 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152155,9 +152804,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152274,9 +152923,9 @@ x-webhooks: type: string to: type: string - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152359,7 +153008,7 @@ x-webhooks: type: string enum: - archived - changes: &754 + changes: &758 type: object properties: archived_at: @@ -152373,9 +153022,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *709 - organization: *710 - projects_v2_item: &751 + installation: *713 + organization: *714 + projects_v2_item: &755 title: Projects v2 Item description: An item belonging to a project type: object @@ -152393,7 +153042,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *253 + content_type: *259 creator: *4 created_at: type: string @@ -152510,9 +153159,9 @@ x-webhooks: nullable: true to: type: string - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152594,9 +153243,9 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152677,9 +153326,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152785,7 +153434,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &752 + - &756 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -152807,7 +153456,7 @@ x-webhooks: required: - id - name - - &753 + - &757 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -152841,8 +153490,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *752 - - *753 + - *756 + - *757 required: - field_value - type: object @@ -152858,9 +153507,9 @@ x-webhooks: nullable: true required: - body - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152955,9 +153604,9 @@ x-webhooks: to: type: string nullable: true - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -153040,10 +153689,10 @@ x-webhooks: type: string enum: - restored - changes: *754 - installation: *709 - organization: *710 - projects_v2_item: *751 + changes: *758 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -153125,9 +153774,9 @@ x-webhooks: type: string enum: - reopened - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -153208,14 +153857,14 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2_status_update: &757 + installation: *713 + organization: *714 + projects_v2_status_update: &761 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *755 - required: *756 + properties: *759 + required: *760 sender: *4 required: - action @@ -153296,9 +153945,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2_status_update: *757 + installation: *713 + organization: *714 + projects_v2_status_update: *761 sender: *4 required: - action @@ -153434,9 +154083,9 @@ x-webhooks: type: string format: date nullable: true - installation: *709 - organization: *710 - projects_v2_status_update: *757 + installation: *713 + organization: *714 + projects_v2_status_update: *761 sender: *4 required: - action @@ -153507,10 +154156,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - repository @@ -153587,13 +154236,13 @@ x-webhooks: type: string enum: - assigned - assignee: *728 - enterprise: *708 - installation: *709 - number: &758 + assignee: *732 + enterprise: *712 + installation: *713 + number: &762 description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -155876,7 +156525,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -155958,11 +156607,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -158240,7 +158889,7 @@ x-webhooks: - draft reason: type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -158322,11 +158971,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -160604,7 +161253,7 @@ x-webhooks: - draft reason: type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -160686,13 +161335,13 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: &759 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: &763 allOf: - - *571 + - *568 - type: object properties: allow_auto_merge: @@ -160754,7 +161403,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *711 + repository: *715 sender: *4 required: - action @@ -160835,12 +161484,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -160920,11 +161569,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *708 - milestone: *555 - number: *758 - organization: *710 - pull_request: &760 + enterprise: *712 + milestone: *550 + number: *762 + organization: *714 + pull_request: &764 title: Pull Request type: object properties: @@ -163187,7 +163836,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -163266,11 +163915,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -165552,7 +166201,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *711 + repository: *715 sender: *4 required: - action @@ -165676,12 +166325,12 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -165761,11 +166410,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -168032,7 +168681,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -168112,11 +168761,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *708 - installation: *709 - label: *727 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + label: *731 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -170398,7 +171047,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -170479,10 +171128,10 @@ x-webhooks: type: string enum: - locked - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -172762,7 +173411,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -172842,12 +173491,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *708 - milestone: *555 - number: *758 - organization: *710 - pull_request: *760 - repository: *711 + enterprise: *712 + milestone: *550 + number: *762 + organization: *714 + pull_request: *764 + repository: *715 sender: *4 required: - action @@ -172926,12 +173575,12 @@ x-webhooks: type: string enum: - opened - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173012,12 +173661,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173097,12 +173746,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173468,9 +174117,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -175640,7 +176289,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -175720,7 +176369,7 @@ x-webhooks: type: string enum: - deleted - comment: &762 + comment: &766 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176005,9 +176654,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -178165,7 +178814,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -178245,11 +178894,11 @@ x-webhooks: type: string enum: - edited - changes: *761 - comment: *762 - enterprise: *708 - installation: *709 - organization: *710 + changes: *765 + comment: *766 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -180410,7 +181059,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -180491,9 +181140,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -182666,7 +183315,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 review: description: The review that was affected. type: object @@ -182913,9 +183562,9 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -184969,8 +185618,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 - review: &763 + repository: *715 + review: &767 description: The review that was affected. type: object properties: @@ -185203,12 +185852,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -187491,7 +188140,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_reviewer: title: User type: object @@ -187575,12 +188224,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -189870,7 +190519,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190062,12 +190711,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -192352,7 +193001,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_reviewer: title: User type: object @@ -192437,12 +193086,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -194718,7 +195367,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194899,9 +195548,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -197076,8 +197725,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 - review: *763 + repository: *715 + review: *767 sender: *4 required: - action @@ -197157,9 +197806,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -199229,7 +199878,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 sender: *4 thread: type: object @@ -199616,9 +200265,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -201674,7 +202323,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 sender: *4 thread: type: object @@ -202064,10 +202713,10 @@ x-webhooks: type: string before: type: string - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -204338,7 +204987,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -204420,11 +205069,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *764 - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + assignee: *768 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -206707,7 +207356,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -206786,11 +207435,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *708 - installation: *709 - label: *727 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + label: *731 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -209063,7 +209712,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -209144,10 +209793,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -211412,7 +212061,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -211612,7 +212261,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *708 + enterprise: *712 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -211704,8 +212353,8 @@ x-webhooks: - url - author - committer - installation: *709 - organization: *710 + installation: *713 + organization: *714 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212280,9 +212929,9 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 registry_package: type: object properties: @@ -212728,7 +213377,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *745 + items: *749 summary: type: string tag_name: @@ -212782,7 +213431,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -212860,9 +213509,9 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 registry_package: type: object properties: @@ -213170,7 +213819,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *745 + items: *749 summary: type: string tag_name: @@ -213219,7 +213868,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -213296,10 +213945,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - release: &765 + enterprise: *712 + installation: *713 + organization: *714 + release: &769 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213617,7 +214266,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *711 + repository: *715 sender: *4 required: - action @@ -213694,11 +214343,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -213815,11 +214464,11 @@ x-webhooks: type: boolean required: - to - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -213897,9 +214546,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214221,7 +214870,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *711 + repository: *715 sender: *4 required: - action @@ -214297,10 +214946,10 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - release: &766 + enterprise: *712 + installation: *713 + organization: *714 + release: &770 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214619,7 +215268,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *711 + repository: *715 sender: *4 required: - action @@ -214695,11 +215344,11 @@ x-webhooks: type: string enum: - released - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -214775,11 +215424,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *708 - installation: *709 - organization: *710 - release: *766 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *770 + repository: *715 sender: *4 required: - action @@ -214855,11 +215504,11 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_advisory: *627 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_advisory: *632 sender: *4 required: - action @@ -214935,11 +215584,11 @@ x-webhooks: type: string enum: - reported - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_advisory: *627 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_advisory: *632 sender: *4 required: - action @@ -215015,10 +215664,10 @@ x-webhooks: type: string enum: - archived - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215095,10 +215744,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215176,10 +215825,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215263,10 +215912,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215378,10 +216027,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215453,10 +216102,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 status: type: string @@ -215537,10 +216186,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215617,10 +216266,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215714,10 +216363,10 @@ x-webhooks: - name required: - repository - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215797,11 +216446,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 sender: *4 required: - action @@ -215879,11 +216528,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 sender: *4 required: - action @@ -215961,11 +216610,11 @@ x-webhooks: type: string enum: - edited - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 changes: type: object properties: @@ -215984,16 +216633,16 @@ x-webhooks: properties: added: type: array - items: *266 + items: *271 deleted: type: array - items: *266 + items: *271 updated: type: array items: type: object properties: - condition: *266 + condition: *271 changes: type: object properties: @@ -216026,16 +216675,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *589 deleted: type: array - items: *592 + items: *589 updated: type: array items: type: object properties: - rule: *592 + rule: *589 changes: type: object properties: @@ -216269,10 +216918,10 @@ x-webhooks: - from required: - owner - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216350,10 +216999,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216431,7 +217080,7 @@ x-webhooks: type: string enum: - create - alert: &767 + alert: &771 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216552,10 +217201,10 @@ x-webhooks: type: string enum: - open - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216761,10 +217410,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216842,11 +217491,11 @@ x-webhooks: type: string enum: - reopen - alert: *767 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *771 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217045,10 +217694,10 @@ x-webhooks: enum: - fixed - open - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217126,11 +217775,11 @@ x-webhooks: type: string enum: - created - alert: &768 + alert: &772 type: object properties: - number: *54 - created_at: *55 + number: *158 + created_at: *159 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217138,8 +217787,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *56 - html_url: *57 + url: *161 + html_url: *162 locations_url: type: string format: uri @@ -217244,10 +217893,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217328,11 +217977,11 @@ x-webhooks: type: string enum: - created - alert: *768 - installation: *709 - location: *769 - organization: *710 - repository: *711 + alert: *772 + installation: *713 + location: *773 + organization: *714 + repository: *715 sender: *4 required: - location @@ -217570,11 +218219,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217652,11 +218301,11 @@ x-webhooks: type: string enum: - reopened - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217734,11 +218383,11 @@ x-webhooks: type: string enum: - resolved - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217816,11 +218465,11 @@ x-webhooks: type: string enum: - validated - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217946,10 +218595,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *711 - enterprise: *708 - installation: *709 - organization: *710 + repository: *715 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -218027,11 +218676,11 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - security_advisory: &770 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + security_advisory: &774 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218214,11 +218863,11 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - security_advisory: *770 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + security_advisory: *774 sender: *4 required: - action @@ -218291,10 +218940,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218478,11 +219127,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *265 - enterprise: *708 - installation: *709 - organization: *710 - repository: *338 + security_and_analysis: *270 + enterprise: *712 + installation: *713 + organization: *714 + repository: *333 sender: *4 required: - changes @@ -218560,12 +219209,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: &771 + sponsorship: &775 type: object properties: created_at: @@ -218866,12 +219515,12 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - sponsorship @@ -218959,12 +219608,12 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219041,17 +219690,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &772 + effective_date: &776 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - sponsorship @@ -219125,7 +219774,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &773 + changes: &777 type: object properties: tier: @@ -219169,13 +219818,13 @@ x-webhooks: - from required: - tier - effective_date: *772 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + effective_date: *776 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219252,13 +219901,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *773 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + changes: *777 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219332,10 +219981,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219418,10 +220067,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219841,15 +220490,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *708 + enterprise: *712 id: description: The unique identifier of the status. type: integer - installation: *709 + installation: *713 name: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 sha: description: The Commit SHA. @@ -219958,15 +220607,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - parent_issue_repo: *67 + parent_issue: *70 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - installation: *709 - organization: *710 - repository: *711 + sub_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220050,15 +220699,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - parent_issue_repo: *67 + parent_issue: *70 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - installation: *709 - organization: *710 - repository: *711 + sub_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220142,15 +220791,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - sub_issue_repo: *67 + sub_issue: *70 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - installation: *709 - organization: *710 - repository: *711 + parent_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220234,15 +220883,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - sub_issue_repo: *67 + sub_issue: *70 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - installation: *709 - organization: *710 - repository: *711 + parent_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220319,12 +220968,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - team: &774 + team: &778 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220547,9 +221196,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -221007,7 +221656,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -221083,9 +221732,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -221543,7 +222192,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -221620,9 +222269,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -222080,7 +222729,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -222224,9 +222873,9 @@ x-webhooks: - from required: - permissions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -222684,7 +223333,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - changes @@ -222762,9 +223411,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -223222,7 +223871,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -223298,10 +223947,10 @@ x-webhooks: type: string enum: - started - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -223374,16 +224023,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *708 + enterprise: *712 inputs: type: object nullable: true additionalProperties: true - installation: *709 - organization: *710 + installation: *713 + organization: *714 ref: type: string - repository: *711 + repository: *715 sender: *4 workflow: type: string @@ -223465,10 +224114,10 @@ x-webhooks: type: string enum: - completed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: allOf: @@ -223705,7 +224354,7 @@ x-webhooks: type: string required: - conclusion - deployment: *488 + deployment: *483 required: - action - repository @@ -223784,10 +224433,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: allOf: @@ -224047,7 +224696,7 @@ x-webhooks: required: - status - steps - deployment: *488 + deployment: *483 required: - action - repository @@ -224126,10 +224775,10 @@ x-webhooks: type: string enum: - queued - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: type: object @@ -224264,7 +224913,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *488 + deployment: *483 required: - action - repository @@ -224343,10 +224992,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: type: object @@ -224482,7 +225131,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *488 + deployment: *483 required: - action - repository @@ -224562,12 +225211,12 @@ x-webhooks: type: string enum: - completed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object @@ -225566,12 +226215,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object @@ -226555,12 +227204,12 @@ x-webhooks: type: string enum: - requested - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 744d87ec2..4337ba53d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -172,6 +172,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -4882,6 +4886,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -5079,6 +5091,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -5826,6 +5847,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6023,6 +6052,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -6624,6 +6662,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6821,6 +6867,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -7053,6 +7108,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -7250,6 +7313,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -9037,6 +9109,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -9234,6 +9314,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -10032,6 +10121,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -10229,6 +10326,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -10944,6 +11050,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11141,6 +11255,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -11567,6 +11690,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11764,6 +11895,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -20480,29 +20620,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -22110,1758 +22227,6 @@ } } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { - "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", - "tags": [ - "secret-scanning" - ], - "operationId": "secret-scanning/list-alerts-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "is_multi_repo", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "hide_secret", - "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "type": "string", - "enum": [ - "open", - "resolved" - ] - }, - "resolution": { - "type": "string", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { - "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - }, - "first_location_detected": { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ], - "nullable": true - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - }, - "assigned_to": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, - "has_more_locations": true, - "assigned_to": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" - } - } - }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", @@ -24092,6 +22457,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -25406,6 +23781,772 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -25634,6 +24775,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -65202,10 +64353,377 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + }, + "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": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "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", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -65349,7 +64867,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -65357,7 +64875,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -65365,7 +64883,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -67564,6 +67082,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -67667,6 +67190,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -67807,6 +67334,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -67825,6 +67357,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -67905,6 +67442,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -68008,6 +67550,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -68063,6 +67609,587 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, + "examples": { + "default": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -68612,6 +68739,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -68715,6 +68847,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -68830,6 +68966,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -68899,6 +69040,261 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -69002,247 +69398,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "example": true - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -74717,6 +74876,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -74820,6 +74984,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -83791,6 +83959,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -85346,7 +85618,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -85357,8 +85630,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -100085,29 +100369,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -117424,6 +117685,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -117621,6 +117890,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -118383,6 +118661,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -118580,6 +118866,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -148274,16 +148569,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -155438,16 +155739,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -304039,16 +304346,6 @@ "default": "desc" } }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -304076,29 +304373,6 @@ "schema": { "type": "string" } - }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "responses": { @@ -340316,6 +340590,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -340513,6 +340795,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -488890,7 +489181,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -557033,6 +557324,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -557230,6 +557529,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -617170,6 +617478,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -617367,6 +617683,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -624057,16 +624382,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -631194,16 +631525,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -655215,7 +655552,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -655346,7 +655683,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -655354,7 +655691,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -655362,7 +655699,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -796595,6 +796932,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -796792,6 +797137,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -799146,6 +799500,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -799343,6 +799705,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -801604,6 +801975,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -801801,6 +802180,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -804062,6 +804450,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -804259,6 +804655,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -806652,6 +807057,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -806849,6 +807262,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -809249,6 +809671,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -809446,6 +809876,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { @@ -813469,6 +813908,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -813666,6 +814113,15 @@ "read", "write" ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] } }, "example": { diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index f6e9af8bd..fafcda969 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -855,7 +857,7 @@ paths: - subscriptions_url - type - url - type: &307 + type: &302 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &629 + - &634 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1139,7 +1141,7 @@ paths: GitHub. type: object nullable: true - properties: &68 + properties: &67 id: description: Unique identifier of the GitHub app example: 37 @@ -1272,7 +1274,7 @@ paths: about itself. example: 5 type: integer - required: &69 + required: &68 - id - node_id - owner @@ -1577,7 +1579,7 @@ paths: schema: type: integer default: 30 - - &187 + - &194 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1593,7 +1595,7 @@ paths: application/json: schema: type: array - items: &188 + items: &195 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1673,7 +1675,7 @@ paths: - installation_id - repository_id examples: - default: &189 + default: &196 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1801,7 +1803,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &197 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1915,7 +1917,7 @@ paths: - request - response examples: - default: &191 + default: &198 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2116,7 +2118,7 @@ paths: parameters: - *17 - *19 - - &79 + - &77 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2360,6 +2362,14 @@ paths: token to update GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token to view and edit custom properties for an organization, + when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access @@ -2540,6 +2550,15 @@ paths: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token for organization custom properties management at + the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -2653,7 +2672,7 @@ paths: suspended_at: suspended_by: headers: - Link: &58 + Link: &54 example: ; rel="next", ; rel="last" schema: @@ -2842,11 +2861,11 @@ paths: - selected repositories: type: array - items: &67 + items: &66 title: Repository description: A repository on GitHub. type: object - properties: &263 + properties: &268 id: description: Unique identifier of the repository example: 42 @@ -2866,7 +2885,7 @@ paths: title: License Simple description: License Simple type: object - properties: &74 + properties: &73 key: type: string example: mit @@ -2888,7 +2907,7 @@ paths: html_url: type: string format: uri - required: &75 + required: &74 - key - name - url @@ -3284,7 +3303,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &264 + required: &269 - archive_url - assignees_url - blobs_url @@ -5071,7 +5090,7 @@ paths: responses: '202': *39 '422': *7 - '500': &106 + '500': &105 description: Internal Error content: application/json: @@ -7395,7 +7414,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &159 + code_scanning_options: &168 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7589,7 +7608,7 @@ paths: description: Response content: application/json: - schema: &161 + schema: &170 type: array description: A list of default code security configurations items: @@ -7605,7 +7624,7 @@ paths: default configuration: *43 examples: - default: &162 + default: &171 value: - default_for_new_repos: public configuration: @@ -7936,7 +7955,7 @@ paths: - *42 - *45 responses: - '204': &163 + '204': &172 description: A header with no content is returned. '400': *14 '403': *29 @@ -8063,7 +8082,7 @@ paths: default: value: default_for_new_repos: all - configuration: &160 + configuration: &169 value: id: 1325 target_type: organization @@ -8148,7 +8167,7 @@ paths: application/json: schema: type: array - items: &164 + items: &173 type: object description: Repositories associated with a code security configuration and attachment status @@ -8170,7 +8189,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &103 + properties: &102 id: type: integer format: int64 @@ -8397,7 +8416,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &104 + required: &103 - archive_url - assignees_url - blobs_url @@ -8449,7 +8468,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &165 + repository: &174 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8543,7 +8562,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &170 + - &179 name: state in: query description: |- @@ -8552,7 +8571,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &171 + - &180 name: severity in: query description: |- @@ -8561,7 +8580,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &172 + - &181 name: ecosystem in: query description: |- @@ -8570,14 +8589,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &173 + - &182 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &174 + - &183 name: epss_percentage in: query description: |- @@ -8589,7 +8608,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &479 + - &474 name: has in: query description: |- @@ -8603,7 +8622,7 @@ paths: type: string enum: - patch - - &175 + - &184 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8613,7 +8632,7 @@ paths: enum: - development - runtime - - &176 + - &185 name: sort in: query description: |- @@ -8631,31 +8650,6 @@ paths: - *48 - *40 - *41 - - &177 - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - &178 - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - *17 responses: '200': @@ -8664,11 +8658,11 @@ paths: application/json: schema: type: array - items: &179 + items: &186 type: object description: A Dependabot alert. properties: - number: &54 + number: &158 type: integer description: The security alert number. readOnly: true @@ -8730,7 +8724,7 @@ paths: - unknown - direct - transitive - security_advisory: &480 + security_advisory: &475 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8933,29 +8927,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *52 - url: &56 + url: &161 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &57 + html_url: &162 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &55 + created_at: &159 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &153 + updated_at: &160 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &155 + dismissed_at: &164 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8985,14 +8979,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &154 + fixed_at: &163 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &481 + auto_dismissed_at: &476 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9018,7 +9012,7 @@ paths: - repository additionalProperties: false examples: - default: &180 + default: &187 value: - number: 2 state: dismissed @@ -9346,718 +9340,6 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise - parameters: - - *42 - - &295 - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - - &296 - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default - secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - - &297 - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false - schema: - type: string - - &298 - name: sort - description: The property to sort the results by. `created` means when the - alert was created. `updated` means when the alert was updated or resolved. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - *48 - - *17 - - *40 - - *41 - - &299 - name: validity - in: query - description: A comma-separated list of validities that, when present, will - return alerts that match the validities in this list. Valid options are - `active`, `inactive`, and `unknown`. - required: false - schema: - type: string - - &300 - name: is_publicly_leaked - in: query - description: A boolean value representing whether or not to filter alerts - by the publicly-leaked tag being present. - required: false - schema: - type: boolean - default: false - - &301 - name: is_multi_repo - in: query - description: A boolean value representing whether or not to filter alerts - by the multi-repo tag being present. - required: false - schema: - type: boolean - default: false - - &302 - name: hide_secret - in: query - description: A boolean value representing whether or not to hide literal secrets - in the results. - required: false - schema: - type: boolean - default: false - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &303 - type: object - properties: - number: *54 - created_at: *55 - updated_at: - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - url: *56 - html_url: *57 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: &607 - description: Sets the state of the secret scanning alert. You - must provide `resolution` when you set the state to `resolved`. - type: string - enum: - - open - - resolved - resolution: &608 - type: string - description: "**Required when the `state` is `resolved`.** The - reason for resolving the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: - type: string - description: The secret that was detected. - repository: *53 - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected - secret. - nullable: true - push_protection_bypassed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection - bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection - bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: - type: string - description: The comment that was optionally added when this - alert was closed - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple - repositories in the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert - is base64 encoded - nullable: true - first_location_detected: - description: 'Details on the location where the token was initially - detected. This can be a commit, wiki commit, issue, discussion, - pull request. - - ' - oneOf: &609 - - &611 - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - &612 - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - &613 - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - &614 - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - &615 - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - &616 - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - &617 - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - &618 - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - &619 - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - &620 - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - &621 - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - &622 - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - &623 - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - nullable: true - has_more_locations: - type: boolean - description: A boolean value representing whether or not the - token in the alert was detected in more than one location. - assigned_to: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - examples: - default: &304 - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: active - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *58 - '404': *6 - '503': &77 - description: Service unavailable - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning "/enterprises/{enterprise}/teams": get: summary: List enterprise teams @@ -10079,7 +9361,7 @@ paths: application/json: schema: type: array - items: &59 + items: &55 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10137,7 +9419,7 @@ paths: - updated_at - group_id examples: - default: &60 + default: &56 value: - id: 1 name: Justice League @@ -10150,7 +9432,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10193,6 +9475,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10211,9 +9505,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10231,7 +9525,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *42 - - &61 + - &57 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10250,7 +9544,7 @@ paths: type: array items: *4 examples: - default: &62 + default: &58 value: - login: octocat id: 1 @@ -10271,7 +9565,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10289,7 +9583,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *42 - - *61 + - *57 requestBody: required: true content: @@ -10320,7 +9614,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10338,7 +9632,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *42 - - *61 + - *57 requestBody: required: true content: @@ -10369,7 +9663,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10387,8 +9681,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *42 - - *61 - - &63 + - *57 + - &59 name: username description: The handle for the GitHub user account. in: path @@ -10402,7 +9696,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &64 + exampleKey1: &60 value: login: octocat id: 1 @@ -10438,8 +9732,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *42 - - *61 - - *63 + - *57 + - *59 responses: '201': description: Successfully added team member @@ -10447,7 +9741,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *64 + exampleKey1: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10465,8 +9759,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *42 - - *61 - - *63 + - *57 + - *59 responses: '204': description: Response @@ -10476,6 +9770,290 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - *42 + - *57 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: &61 + title: Organization Simple + description: A GitHub organization. + type: object + properties: &176 + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: &177 + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + examples: + default: &62 + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - *42 + - *57 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: *61 + examples: + default: &101 + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - *42 + - *57 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - *42 + - *57 + - &63 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *61 + examples: + default: *62 + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - *42 + - *57 + - *63 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *61 + examples: + default: *62 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - *42 + - *57 + - *63 + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -10491,7 +10069,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *42 - - &65 + - &64 name: team_slug description: The slug of the team name. in: path @@ -10503,11 +10081,11 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10525,7 +10103,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *42 - - *65 + - *64 requestBody: required: true content: @@ -10551,6 +10129,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10568,11 +10158,11 @@ paths: description: Response content: application/json: - schema: *59 + schema: *55 examples: - default: *60 + default: *56 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -10593,7 +10183,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *42 - - *65 + - *64 responses: '204': description: Response @@ -10631,7 +10221,7 @@ paths: application/json: schema: type: array - items: &98 + items: &96 title: Event description: Event type: object @@ -10641,7 +10231,7 @@ paths: type: type: string nullable: true - actor: &66 + actor: &65 title: Actor description: Actor type: object @@ -10681,7 +10271,7 @@ paths: - id - name - url - org: *66 + org: *65 payload: oneOf: - title: CreateEvent @@ -10727,7 +10317,7 @@ paths: properties: action: type: string - discussion: &724 + discussion: &728 title: Discussion description: A Discussion in a repository. type: object @@ -11014,7 +10604,7 @@ paths: - id labels: type: array - items: &70 + items: &69 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11089,12 +10679,12 @@ paths: properties: action: type: string - issue: &71 + issue: &70 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &529 + properties: &524 id: type: integer format: int64 @@ -11208,7 +10798,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &250 + properties: &256 url: type: string format: uri @@ -11278,7 +10868,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &251 + required: &257 - closed_issues - creator - description @@ -11357,7 +10947,7 @@ paths: timeline_url: type: string format: uri - type: &209 + type: &216 title: Issue Type description: The type of issue. type: object @@ -11407,7 +10997,7 @@ paths: - node_id - name - description - repository: *67 + repository: *66 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11418,9 +11008,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - author_association: &72 + properties: *67 + required: *68 + author_association: &71 title: author_association type: string example: OWNER @@ -11435,7 +11025,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &73 + reactions: &72 title: Reaction Rollup type: object properties: @@ -11471,7 +11061,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &641 + sub_issues_summary: &646 title: Sub-issues Summary type: object properties: @@ -11491,7 +11081,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &642 + issue_dependencies_summary: &647 title: Issue Dependencies Summary type: object properties: @@ -11510,7 +11100,7 @@ paths: - total_blocking issue_field_values: type: array - items: &643 + items: &648 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11571,7 +11161,7 @@ paths: - node_id - data_type - value - required: &530 + required: &525 - assignee - closed_at - comments @@ -11596,10 +11186,10 @@ paths: assignees: type: array items: *4 - label: *70 + label: *69 labels: type: array - items: *70 + items: *69 required: - action - issue @@ -11608,8 +11198,8 @@ paths: properties: action: type: string - issue: *71 - comment: &527 + issue: *70 + comment: &522 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11657,7 +11247,7 @@ paths: issue_url: type: string format: uri - author_association: *72 + author_association: *71 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -11668,9 +11258,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - id - node_id @@ -11843,8 +11433,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true allow_forking: type: boolean @@ -11933,7 +11523,7 @@ paths: type: string number: type: integer - pull_request: &76 + pull_request: &75 title: Pull Request Minimal type: object properties: @@ -12004,10 +11594,10 @@ paths: assignees: type: array items: *4 - label: *70 + label: *69 labels: type: array - items: *70 + items: *69 required: - action - number @@ -12017,7 +11607,7 @@ paths: properties: action: type: string - pull_request: *76 + pull_request: *75 comment: type: object properties: @@ -12268,7 +11858,7 @@ paths: - pull_request updated_at: type: string - pull_request: *76 + pull_request: *75 required: - action - review @@ -12317,7 +11907,7 @@ paths: updated_at: type: string format: date-time - reactions: *73 + reactions: *72 required: - action - comment @@ -12328,7 +11918,7 @@ paths: type: string release: allOf: - - &582 + - &579 title: Release description: A release. type: object @@ -12399,7 +11989,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &580 title: Release Asset description: Data related to a release. type: object @@ -12474,7 +12064,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *73 + reactions: *72 required: - assets_url - upload_url @@ -12566,7 +12156,19 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *77 + '503': &106 + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12647,7 +12249,7 @@ paths: _links: type: object properties: - timeline: &78 + timeline: &76 title: Link With Type description: Hypermedia Link with Type type: object @@ -12659,17 +12261,17 @@ paths: required: - href - type - user: *78 - security_advisories: *78 - current_user: *78 - current_user_public: *78 - current_user_actor: *78 - current_user_organization: *78 + user: *76 + security_advisories: *76 + current_user: *76 + current_user_public: *76 + current_user_actor: *76 + current_user_organization: *76 current_user_organizations: type: array - items: *78 - repository_discussions: *78 - repository_discussions_category: *78 + items: *76 + repository_discussions: *76 + repository_discussions_category: *76 required: - timeline - user @@ -12731,7 +12333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *79 + - *77 - *17 - *19 responses: @@ -12741,7 +12343,7 @@ paths: application/json: schema: type: array - items: &80 + items: &78 title: Base Gist description: Base Gist type: object @@ -12840,7 +12442,7 @@ paths: - created_at - updated_at examples: - default: &81 + default: &79 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -12885,7 +12487,7 @@ paths: site_admin: false truncated: false headers: - Link: *58 + Link: *54 '304': *37 '403': *29 x-github: @@ -12961,7 +12563,7 @@ paths: description: Response content: application/json: - schema: &82 + schema: &80 title: Gist Simple description: Gist Simple type: object @@ -12978,7 +12580,7 @@ paths: url: type: string format: uri - user: &655 + user: &660 title: Public User description: Public User type: object @@ -13340,7 +12942,7 @@ paths: truncated: type: boolean examples: - default: &83 + default: &81 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13444,7 +13046,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *79 + - *77 - *17 - *19 responses: @@ -13454,11 +13056,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '403': *29 @@ -13478,7 +13080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *79 + - *77 - *17 - *19 responses: @@ -13488,11 +13090,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '401': *25 '304': *37 '403': *29 @@ -13518,7 +13120,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &84 + - &82 name: gist_id description: The unique identifier of the gist. in: path @@ -13530,10 +13132,10 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - default: *83 - '403': &87 + default: *81 + '403': &85 description: Forbidden Gist content: application/json: @@ -13581,7 +13183,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *84 + - *82 requestBody: required: true content: @@ -13641,9 +13243,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - updateGist: *83 + updateGist: *81 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -13801,7 +13403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -13830,7 +13432,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *84 + - *82 - *17 - *19 responses: @@ -13840,7 +13442,7 @@ paths: application/json: schema: type: array - items: &85 + items: &83 title: Gist Comment description: A comment made to a gist. type: object @@ -13875,7 +13477,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *72 + author_association: *71 required: - url - id @@ -13915,7 +13517,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -13940,7 +13542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *84 + - *82 requestBody: required: true content: @@ -13965,9 +13567,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: &86 + default: &84 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14025,8 +13627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *84 - - &88 + - *82 + - &86 name: comment_id description: The unique identifier of the comment. in: path @@ -14039,12 +13641,12 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: *86 + default: *84 '304': *37 '404': *6 - '403': *87 + '403': *85 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14066,8 +13668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *84 - - *88 + - *82 + - *86 requestBody: required: true content: @@ -14092,9 +13694,9 @@ paths: description: Response content: application/json: - schema: *85 + schema: *83 examples: - default: *86 + default: *84 '404': *6 x-github: githubCloudOnly: false @@ -14111,8 +13713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *84 - - *88 + - *82 + - *86 responses: '204': description: Response @@ -14135,7 +13737,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *84 + - *82 - *17 - *19 responses: @@ -14236,7 +13838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *84 + - *82 - *17 - *19 responses: @@ -14246,7 +13848,7 @@ paths: application/json: schema: type: array - items: *82 + items: *80 examples: default: value: @@ -14292,7 +13894,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '404': *6 '304': *37 '403': *29 @@ -14311,13 +13913,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *84 + - *82 responses: '201': description: Response content: application/json: - schema: *80 + schema: *78 examples: default: value: @@ -14388,7 +13990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *84 + - *82 responses: '204': description: Response if gist is starred @@ -14418,7 +14020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -14440,7 +14042,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *84 + - *82 responses: '204': description: Response @@ -14469,7 +14071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *84 + - *82 - name: sha in: path required: true @@ -14480,9 +14082,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *80 examples: - default: *83 + default: *81 '422': *15 '404': *6 '403': *29 @@ -14641,7 +14243,7 @@ paths: type: integer repositories: type: array - items: *67 + items: *66 repository_selection: type: string example: selected @@ -14764,7 +14366,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '403': *29 '304': *37 '401': *25 @@ -14848,7 +14450,7 @@ paths: - closed - all default: open - - &212 + - &219 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -14867,7 +14469,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - name: collab in: query required: false @@ -14897,9 +14499,9 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: &213 + default: &220 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15144,7 +14746,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '404': *6 @@ -15183,8 +14785,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 examples: default: value: @@ -15469,7 +15071,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &89 + X-CommonMarker-Version: &87 example: 0.17.4 schema: type: string @@ -15524,7 +15126,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *89 + X-CommonMarker-Version: *87 content: text/html: schema: @@ -15553,7 +15155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &92 + - &90 name: account_id description: account_id parameter in: path @@ -15565,7 +15167,7 @@ paths: description: Response content: application/json: - schema: &91 + schema: &89 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -15595,7 +15197,7 @@ paths: nullable: true id: type: integer - plan: &90 + plan: &88 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -15684,7 +15286,7 @@ paths: nullable: true updated_at: type: string - plan: *90 + plan: *88 required: - url - id @@ -15692,7 +15294,7 @@ paths: - login - marketplace_purchase examples: - default: &93 + default: &91 value: url: https://api.github.com/orgs/github type: Organization @@ -15777,9 +15379,9 @@ paths: application/json: schema: type: array - items: *90 + items: *88 examples: - default: &94 + default: &92 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -15797,7 +15399,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '404': *6 '401': *25 x-github: @@ -15819,14 +15421,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &95 + - &93 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &96 + - &94 name: sort description: The property to sort the results by. in: query @@ -15856,9 +15458,9 @@ paths: application/json: schema: type: array - items: *91 + items: *89 examples: - default: &97 + default: &95 value: - url: https://api.github.com/orgs/github type: Organization @@ -15909,7 +15511,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '404': *6 '422': *15 '401': *25 @@ -15932,15 +15534,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *92 + - *90 responses: '200': description: Response content: application/json: - schema: *91 + schema: *89 examples: - default: *93 + default: *91 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -15972,11 +15574,11 @@ paths: application/json: schema: type: array - items: *90 + items: *88 examples: - default: *94 + default: *92 headers: - Link: *58 + Link: *54 '401': *25 x-github: githubCloudOnly: false @@ -15997,8 +15599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *95 - - *96 + - *93 + - *94 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16018,11 +15620,11 @@ paths: application/json: schema: type: array - items: *91 + items: *89 examples: - default: *97 + default: *95 headers: - Link: *58 + Link: *54 '401': *25 x-github: githubCloudOnly: false @@ -16284,14 +15886,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &330 + - &325 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &331 + - &326 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16308,7 +15910,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -16353,7 +15955,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &339 + '301': &334 description: Moved permanently content: application/json: @@ -16375,7 +15977,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &558 + - &553 name: all description: If `true`, show notifications marked as read. in: query @@ -16383,7 +15985,7 @@ paths: schema: type: boolean default: false - - &559 + - &554 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16392,8 +15994,8 @@ paths: schema: type: boolean default: false - - *79 - - &560 + - *77 + - &555 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -16418,18 +16020,18 @@ paths: application/json: schema: type: array - items: &99 + items: &97 title: Thread description: Thread type: object properties: id: type: string - repository: &137 + repository: &142 title: Minimal Repository description: Minimal Repository type: object - properties: &182 + properties: &189 id: type: integer format: int64 @@ -16705,7 +16307,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &265 + security_and_analysis: &270 nullable: true type: object properties: @@ -16779,7 +16381,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &183 + required: &190 - archive_url - assignees_url - blobs_url @@ -16867,7 +16469,7 @@ paths: - url - subscription_url examples: - default: &561 + default: &556 value: - id: '1' repository: @@ -16949,7 +16551,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -17033,7 +16635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &100 + - &98 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -17047,7 +16649,7 @@ paths: description: Response content: application/json: - schema: *99 + schema: *97 examples: default: value: @@ -17149,7 +16751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *100 + - *98 responses: '205': description: Reset Content @@ -17171,7 +16773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *100 + - *98 responses: '204': description: No content @@ -17194,13 +16796,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *100 + - *98 responses: '200': description: Response content: application/json: - schema: &101 + schema: &99 title: Thread Subscription description: Thread Subscription type: object @@ -17237,7 +16839,7 @@ paths: - url - subscribed examples: - default: &102 + default: &100 value: subscribed: true ignored: false @@ -17268,7 +16870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *100 + - *98 requestBody: required: false content: @@ -17289,9 +16891,9 @@ paths: description: Response content: application/json: - schema: *101 + schema: *99 examples: - default: *102 + default: *100 '304': *37 '403': *29 '401': *25 @@ -17314,7 +16916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *100 + - *98 responses: '204': description: Response @@ -17409,79 +17011,9 @@ paths: application/json: schema: type: array - items: &218 - title: Organization Simple - description: A GitHub organization. - type: object - properties: &167 - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: &168 - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description + items: *61 examples: - default: &672 - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default: *101 headers: Link: example: ; rel="next" @@ -17508,13 +17040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - &105 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *63 - name: page in: query description: The page number of results to fetch. @@ -17558,8 +17084,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *103 - required: *104 + properties: *102 + required: *103 nullable: true additionalProperties: false examples: @@ -17665,7 +17191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -17731,7 +17257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *105 + - *63 requestBody: required: true content: @@ -17764,12 +17290,131 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &104 + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + examples: + default: &562 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - *63 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: *104 + required: + - properties + examples: + default: &563 + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -17777,7 +17422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *105 + - *63 - &107 name: year description: If specified, only return results for a single year. The value @@ -17787,7 +17432,7 @@ paths: required: false schema: type: integer - - &698 + - &702 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -17811,14 +17456,14 @@ paths: required: false schema: type: string - - &699 + - &703 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &700 + - &704 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -17880,19 +17525,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -17934,8 +17579,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17955,9 +17600,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *105 + - *63 - *107 - - &703 + - &707 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -17967,7 +17612,7 @@ paths: schema: type: integer - *108 - - &704 + - &708 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -18050,8 +17695,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18077,7 +17722,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -18502,7 +18147,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *105 + - *63 requestBody: required: false content: @@ -18752,7 +18397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *105 + - *63 responses: '202': *39 '404': *6 @@ -18777,7 +18422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -18803,7 +18448,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18824,7 +18469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -18842,7 +18487,7 @@ paths: type: integer repository_cache_usages: type: array - items: &344 + items: &339 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18877,7 +18522,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18897,7 +18542,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -18958,13 +18603,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + example: latest required: - id - size_gb - display_name - source nullable: true - machine_size_details: &116 + machine_size_details: &121 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -19047,6 +18697,10 @@ paths: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -19056,7 +18710,7 @@ paths: - public_ip_enabled - platform examples: - default: &136 + default: &141 value: total_count: 2 runners: @@ -19098,7 +18752,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19116,7 +18770,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -19145,6 +18799,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -19162,6 +18821,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -19185,7 +18849,7 @@ paths: application/json: schema: *113 examples: - default: &117 + default: &122 value: id: 5 name: My hosted ubuntu runner @@ -19212,6 +18876,307 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &114 + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` + parameter when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the + image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &116 + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *63 + - &115 + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *114 + examples: + default: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - *63 + - *115 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - *115 + - *63 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: &117 + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image + version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *116 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - *63 + - *115 + - &118 + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" + responses: + '200': + description: Response + content: + application/json: + schema: *117 + examples: + default: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - *63 + - *115 + - *118 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -19224,7 +19189,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19240,7 +19205,7 @@ paths: type: integer images: type: array - items: &114 + items: &119 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -19276,7 +19241,7 @@ paths: - display_name - source examples: - default: &115 + default: &120 value: id: ubuntu-20.04 platform: linux-x64 @@ -19300,7 +19265,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19316,9 +19281,9 @@ paths: type: integer images: type: array - items: *114 + items: *119 examples: - default: *115 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19335,7 +19300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19388,7 +19353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19404,7 +19369,7 @@ paths: type: integer machine_specs: type: array - items: *116 + items: *121 examples: default: value: @@ -19429,7 +19394,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19473,8 +19438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *105 - - &118 + - *63 + - &123 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19488,9 +19453,9 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19508,8 +19473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *105 - - *118 + - *63 + - *123 requestBody: required: true content: @@ -19535,6 +19500,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -19549,7 +19519,7 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19565,8 +19535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *105 - - *118 + - *63 + - *123 responses: '202': description: Response @@ -19574,7 +19544,7 @@ paths: application/json: schema: *113 examples: - default: *117 + default: *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19594,13 +19564,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *105 + - *63 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &119 + schema: &124 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19614,7 +19584,7 @@ paths: required: - include_claim_keys examples: - default: &120 + default: &125 value: include_claim_keys: - repo @@ -19636,20 +19606,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: *119 + schema: *124 examples: - default: *120 + default: *125 responses: '201': description: Empty response content: application/json: - schema: &146 + schema: &151 title: Empty Object description: An object without any properties. type: object @@ -19679,7 +19649,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -19688,7 +19658,7 @@ paths: schema: type: object properties: - enabled_repositories: &121 + enabled_repositories: &126 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19701,7 +19671,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &122 + allowed_actions: &127 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19709,12 +19679,12 @@ paths: - all - local_only - selected - selected_actions_url: &350 + selected_actions_url: &345 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &123 + sha_pinning_required: &128 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19745,7 +19715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -19756,9 +19726,9 @@ paths: schema: type: object properties: - enabled_repositories: *121 - allowed_actions: *122 - sha_pinning_required: *123 + enabled_repositories: *126 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled_repositories examples: @@ -19786,13 +19756,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &354 + schema: &349 type: object properties: days: @@ -19829,12 +19799,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &355 + schema: &350 type: object properties: days: @@ -19871,13 +19841,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &124 + schema: &129 type: object properties: approval_policy: @@ -19891,7 +19861,7 @@ paths: required: - approval_policy examples: - default: &356 + default: &351 value: approval_policy: first_time_contributors '404': *6 @@ -19912,7 +19882,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -19922,7 +19892,7 @@ paths: required: true content: application/json: - schema: *124 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -19944,13 +19914,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &357 + schema: &352 type: object required: - run_workflows_from_fork_pull_requests @@ -19976,7 +19946,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &125 + default: &130 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19999,12 +19969,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &358 + schema: &353 type: object required: - run_workflows_from_fork_pull_requests @@ -20027,7 +19997,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *125 + default: *130 responses: '204': description: Empty response for successful settings update @@ -20057,7 +20027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -20075,9 +20045,9 @@ paths: type: number repositories: type: array - items: *67 + items: *66 examples: - default: &129 + default: &134 value: total_count: 1 repositories: @@ -20217,7 +20187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -20261,8 +20231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *105 - - &126 + - *63 + - &131 name: repository_id description: The unique identifier of the repository. in: path @@ -20290,8 +20260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -20314,13 +20284,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &127 + schema: &132 type: object properties: github_owned_allowed: @@ -20342,7 +20312,7 @@ paths: items: type: string examples: - default: &128 + default: &133 value: github_owned_allowed: true verified_allowed: false @@ -20367,7 +20337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -20375,9 +20345,9 @@ paths: required: false content: application/json: - schema: *127 + schema: *132 examples: - selected_actions: *128 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20397,7 +20367,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -20445,7 +20415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20492,7 +20462,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -20507,9 +20477,9 @@ paths: type: integer repositories: type: array - items: *67 + items: *66 examples: - default: *129 + default: *134 '403': *29 '404': *6 x-github: @@ -20529,7 +20499,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20577,8 +20547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: No content @@ -20604,8 +20574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: No content @@ -20633,23 +20603,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &359 + schema: &354 type: object properties: - default_workflow_permissions: &130 + default_workflow_permissions: &135 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &131 + can_approve_pull_request_reviews: &136 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20657,7 +20627,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &132 + default: &137 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20682,7 +20652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Success response @@ -20690,13 +20660,13 @@ paths: required: false content: application/json: - schema: &360 + schema: &355 type: object properties: - default_workflow_permissions: *130 - can_approve_pull_request_reviews: *131 + default_workflow_permissions: *135 + can_approve_pull_request_reviews: *136 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20716,7 +20686,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *105 + - *63 - *17 - *19 - name: visible_to_repository @@ -20741,7 +20711,7 @@ paths: type: number runner_groups: type: array - items: &133 + items: &138 type: object properties: id: @@ -20857,7 +20827,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -20929,9 +20899,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: - default: &135 + default: &140 value: id: 2 name: octo-runner-group @@ -20966,8 +20936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *105 - - &134 + - *63 + - &139 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20979,7 +20949,7 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: default: value: @@ -21015,8 +20985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21070,9 +21040,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *138 examples: - default: *135 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21091,8 +21061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *105 - - *134 + - *63 + - *139 responses: '204': description: Response @@ -21115,8 +21085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *17 - *19 responses: @@ -21136,9 +21106,9 @@ paths: type: array items: *113 examples: - default: *136 + default: *141 headers: - Link: *58 + Link: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21158,8 +21128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *19 - *17 responses: @@ -21177,9 +21147,9 @@ paths: type: number repositories: type: array - items: *137 + items: *142 examples: - default: &658 + default: &663 value: total_count: 1 repositories: @@ -21431,8 +21401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21476,9 +21446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 - - *126 + - *63 + - *139 + - *131 responses: '204': description: Response @@ -21500,9 +21470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *105 - - *134 - - *126 + - *63 + - *139 + - *131 responses: '204': description: Response @@ -21525,8 +21495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 - *17 - *19 responses: @@ -21544,7 +21514,7 @@ paths: type: number runners: type: array - items: &139 + items: &144 title: Self hosted runners description: A self hosted runner type: object @@ -21573,7 +21543,7 @@ paths: type: boolean labels: type: array - items: &142 + items: &147 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21603,7 +21573,7 @@ paths: - busy - labels examples: - default: &140 + default: &145 value: total_count: 2 runners: @@ -21643,7 +21613,7 @@ paths: name: no-gpu type: custom headers: - Link: *58 + Link: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21662,8 +21632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *105 - - *134 + - *63 + - *139 requestBody: required: true content: @@ -21707,9 +21677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *105 - - *134 - - &138 + - *63 + - *139 + - &143 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21737,9 +21707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *105 - - *134 - - *138 + - *63 + - *139 + - *143 responses: '204': description: Response @@ -21769,7 +21739,7 @@ paths: in: query schema: type: string - - *105 + - *63 - *17 - *19 responses: @@ -21787,11 +21757,11 @@ paths: type: integer runners: type: array - items: *139 + items: *144 examples: - default: *140 + default: *145 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21813,7 +21783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -21821,7 +21791,7 @@ paths: application/json: schema: type: array - items: &361 + items: &356 title: Runner Application description: Runner Application type: object @@ -21846,7 +21816,7 @@ paths: - download_url - filename examples: - default: &362 + default: &357 value: - os: osx architecture: x64 @@ -21889,7 +21859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -21932,7 +21902,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &363 + '201': &358 description: Response content: application/json: @@ -21942,7 +21912,7 @@ paths: - runner - encoded_jit_config properties: - runner: *139 + runner: *144 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21999,13 +21969,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *105 + - *63 responses: '201': description: Response content: application/json: - schema: &141 + schema: &146 title: Authentication Token description: Authentication Token type: object @@ -22027,7 +21997,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *67 + items: *66 single_file: type: string example: config.yaml @@ -22043,7 +22013,7 @@ paths: - token - expires_at examples: - default: &364 + default: &359 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22074,15 +22044,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *105 + - *63 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: &365 + default: &360 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22107,16 +22077,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: '200': description: Response content: application/json: - schema: *139 + schema: *144 examples: - default: &366 + default: &361 value: id: 23 name: MBP @@ -22157,8 +22127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: '204': description: Response @@ -22184,10 +22154,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: - '200': &143 + '200': &148 description: Response content: application/json: @@ -22201,7 +22171,7 @@ paths: type: integer labels: type: array - items: *142 + items: *147 examples: default: value: @@ -22240,8 +22210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 requestBody: required: true content: @@ -22265,7 +22235,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22289,8 +22259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 requestBody: required: true content: @@ -22315,7 +22285,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22339,10 +22309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 + - *63 + - *143 responses: - '200': &367 + '200': &362 description: Response content: application/json: @@ -22356,7 +22326,7 @@ paths: type: integer labels: type: array - items: *142 + items: *147 examples: default: value: @@ -22397,9 +22367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *105 - - *138 - - &368 + - *63 + - *143 + - &363 name: name description: The name of a self-hosted runner's custom label. in: path @@ -22407,7 +22377,7 @@ paths: schema: type: string responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -22432,7 +22402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -22450,7 +22420,7 @@ paths: type: integer secrets: type: array - items: &144 + items: &149 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22500,7 +22470,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22523,13 +22493,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &380 + schema: &375 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22558,7 +22528,7 @@ paths: - key_id - key examples: - default: &381 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22583,8 +22553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *105 - - &145 + - *63 + - &150 name: secret_name description: The name of the secret. in: path @@ -22596,7 +22566,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *149 examples: default: value: @@ -22626,8 +22596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -22684,7 +22654,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -22710,8 +22680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -22737,8 +22707,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -22756,9 +22726,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: &149 + default: &154 value: total_count: 1 repositories: @@ -22850,8 +22820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -22903,8 +22873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -22937,8 +22907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -22970,8 +22940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *105 - - &349 + - *63 + - &344 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -22995,7 +22965,7 @@ paths: type: integer variables: type: array - items: &147 + items: &152 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23059,7 +23029,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23080,7 +23050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *105 + - *63 requestBody: required: true content: @@ -23128,7 +23098,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -23153,8 +23123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *105 - - &148 + - *63 + - &153 name: name description: The name of the variable. in: path @@ -23166,7 +23136,7 @@ paths: description: Response content: application/json: - schema: *147 + schema: *152 examples: default: value: @@ -23196,8 +23166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 requestBody: required: true content: @@ -23259,8 +23229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 responses: '204': description: Response @@ -23286,8 +23256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - *19 - *17 responses: @@ -23305,9 +23275,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23333,8 +23303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 requestBody: required: true content: @@ -23383,8 +23353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - name: repository_id in: path required: true @@ -23418,8 +23388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *105 - - *148 + - *63 + - *153 - name: repository_id in: path required: true @@ -23450,7 +23420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *105 + - *63 requestBody: required: true content: @@ -23582,7 +23552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *105 + - *63 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23667,7 +23637,7 @@ paths: - *17 - *40 - *41 - - *105 + - *63 requestBody: required: true content: @@ -23690,12 +23660,12 @@ paths: required: - subject_digests examples: - default: &687 + default: &691 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &688 + withPredicateType: &692 value: subject_digests: - sha256:abc123 @@ -23753,7 +23723,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &689 + default: &693 value: attestations_subject_digests: - sha256:abc: @@ -23862,7 +23832,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *105 + - *63 requestBody: required: true content: @@ -23927,7 +23897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *105 + - *63 - name: subject_digest description: Subject Digest in: path @@ -23946,6 +23916,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - *17 + - *40 + - *41 + - *63 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -23958,7 +23979,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *105 + - *63 - name: attestation_id description: Attestation ID in: path @@ -23996,7 +24017,7 @@ paths: - *17 - *40 - *41 - - *105 + - *63 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24049,7 +24070,7 @@ paths: initiator: type: string examples: - default: &394 + default: &389 value: attestations: - bundle: @@ -24156,7 +24177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -24168,7 +24189,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24187,8 +24208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: If the user is blocked @@ -24213,8 +24234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -24234,8 +24255,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -24260,7 +24281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *105 + - *63 - *19 - *17 - *48 @@ -24268,7 +24289,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &150 + schema: &155 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24294,7 +24315,7 @@ paths: application/json: schema: type: array - items: &151 + items: &156 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24325,7 +24346,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &169 + items: &178 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24400,7 +24421,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &225 + properties: &231 id: description: Unique identifier of the team type: integer @@ -24472,7 +24493,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &226 + required: &232 - id - node_id - url @@ -24515,7 +24536,7 @@ paths: type: string format: date-time nullable: true - state: *150 + state: *155 contact_link: description: The contact link of the campaign. type: string @@ -24610,9 +24631,9 @@ paths: closed_at: state: open headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24636,7 +24657,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -24700,6 +24721,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -24709,7 +24731,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -24730,9 +24756,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: &152 + default: &157 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24781,7 +24807,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24803,7 +24829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24815,16 +24841,16 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: *152 + default: *157 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24845,7 +24871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24894,7 +24920,7 @@ paths: type: string format: uri nullable: true - state: *150 + state: *155 examples: default: value: @@ -24904,9 +24930,9 @@ paths: description: Response content: application/json: - schema: *151 + schema: *156 examples: - default: *152 + default: *157 '400': description: Bad Request content: @@ -24918,7 +24944,7 @@ paths: content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24939,7 +24965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *105 + - *63 - name: campaign_number description: The campaign number. in: path @@ -24950,7 +24976,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24972,18 +24998,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *105 - - &419 + - *63 + - &414 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &156 + schema: &165 type: string description: The name of the tool used to generate the code scanning analysis. - - &420 + - &415 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -24991,7 +25017,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &157 + schema: &166 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -25006,7 +25032,7 @@ paths: be returned. in: query required: false - schema: &422 + schema: &417 type: string description: State of a code scanning alert. enum: @@ -25029,7 +25055,7 @@ paths: be returned. in: query required: false - schema: &423 + schema: &418 type: string description: Severity of a code scanning alert. enum: @@ -25050,18 +25076,18 @@ paths: items: type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: &424 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: &419 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &158 + state: &167 type: string description: State of a code scanning alert. nullable: true @@ -25069,7 +25095,7 @@ paths: - open - dismissed - fixed - fixed_at: *154 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -25077,8 +25103,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: &425 + dismissed_at: *164 + dismissed_reason: &420 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -25087,13 +25113,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &426 + dismissed_comment: &421 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &427 + rule: &422 type: object properties: id: @@ -25146,25 +25172,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &428 + tool: &423 type: object properties: - name: *156 + name: *165 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *157 - most_recent_instance: &429 + guid: *166 + most_recent_instance: &424 type: object properties: - ref: &421 + ref: &416 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &439 + analysis_key: &434 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25175,13 +25201,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &440 + category: &435 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *158 + state: *167 commit_sha: type: string message: @@ -25475,9 +25501,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25499,7 +25525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *105 + - *63 - name: target_type in: query description: The target type of the code security configuration @@ -25610,7 +25636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *105 + - *63 requestBody: required: true content: @@ -25688,7 +25714,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *159 + code_scanning_options: *168 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25831,7 +25857,7 @@ paths: application/json: schema: *43 examples: - default: *160 + default: *169 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25853,15 +25879,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *161 + schema: *170 examples: - default: *162 + default: *171 '304': *37 '403': *29 '404': *6 @@ -25887,7 +25913,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *105 + - *63 requestBody: required: true content: @@ -25913,7 +25939,7 @@ paths: - 32 - 91 responses: - '204': *163 + '204': *172 '400': *14 '403': *29 '404': *6 @@ -25939,7 +25965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *105 + - *63 - *45 responses: '200': @@ -25948,7 +25974,7 @@ paths: application/json: schema: *43 examples: - default: *160 + default: *169 '304': *37 '403': *29 '404': *6 @@ -25972,7 +25998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26229,10 +26255,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *105 + - *63 - *45 responses: - '204': *163 + '204': *172 '400': *14 '403': *29 '404': *6 @@ -26260,7 +26286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26324,7 +26350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *105 + - *63 - *45 requestBody: required: true @@ -26370,7 +26396,7 @@ paths: default: value: default_for_new_repos: all - configuration: *160 + configuration: *169 '403': *29 '404': *6 x-github: @@ -26394,7 +26420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *105 + - *63 - *45 - name: per_page description: The number of results per page (max 100). For more information, @@ -26423,13 +26449,13 @@ paths: application/json: schema: type: array - items: *164 + items: *173 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *165 + repository: *174 '403': *29 '404': *6 x-github: @@ -26453,7 +26479,7 @@ paths: parameters: - *17 - *19 - - *105 + - *63 responses: '200': description: Response @@ -26469,7 +26495,7 @@ paths: type: integer codespaces: type: array - items: &214 + items: &221 type: object title: Codespace description: A codespace. @@ -26494,12 +26520,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *137 + repository: *142 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &452 + properties: &447 name: type: string description: The name of the machine. @@ -26541,7 +26567,7 @@ paths: - ready - in_progress nullable: true - required: &453 + required: &448 - name - display_name - operating_system @@ -26746,7 +26772,7 @@ paths: - pulls_url - recent_folders examples: - default: &215 + default: &222 value: total_count: 3 codespaces: @@ -27156,7 +27182,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -27178,7 +27204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *105 + - *63 deprecated: true requestBody: required: true @@ -27222,7 +27248,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27245,7 +27271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *105 + - *63 deprecated: true requestBody: required: true @@ -27277,7 +27303,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27300,7 +27326,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *105 + - *63 requestBody: required: true content: @@ -27331,7 +27357,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27352,7 +27378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -27370,7 +27396,7 @@ paths: type: integer secrets: type: array - items: &166 + items: &175 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27409,7 +27435,7 @@ paths: - updated_at - visibility examples: - default: &454 + default: &449 value: total_count: 2 secrets: @@ -27422,7 +27448,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27441,13 +27467,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &455 + schema: &450 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27476,7 +27502,7 @@ paths: - key_id - key examples: - default: &456 + default: &451 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27499,23 +27525,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: Response content: application/json: - schema: *166 + schema: *175 examples: - default: &458 + default: &453 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27535,8 +27561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -27591,7 +27617,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -27617,8 +27643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -27643,8 +27669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -27662,9 +27688,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 '404': *6 x-github: githubCloudOnly: false @@ -27686,8 +27712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -27737,8 +27763,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -27771,8 +27797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -27811,7 +27837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: OK @@ -27920,7 +27946,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -27952,7 +27978,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *105 + - *63 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -27975,7 +28001,7 @@ paths: currently being billed. seats: type: array - items: &217 + items: &224 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27992,15 +28018,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *167 - required: *168 + properties: *176 + required: *177 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *169 - - *59 + - *178 + - *55 nullable: true pending_cancellation_date: type: string @@ -28124,8 +28150,8 @@ paths: type: User site_admin: false headers: - Link: *58 - '500': *106 + Link: *54 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28158,7 +28184,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28200,7 +28226,7 @@ paths: default: value: seats_created: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28236,7 +28262,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28278,7 +28304,7 @@ paths: default: value: seats_cancelled: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28316,7 +28342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28357,7 +28383,7 @@ paths: default: value: seats_created: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28393,7 +28419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *105 + - *63 requestBody: content: application/json: @@ -28435,7 +28461,7 @@ paths: default: value: seats_cancelled: 5 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -28474,7 +28500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *105 + - *63 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -28506,7 +28532,7 @@ paths: application/json: schema: type: array - items: &312 + items: &307 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -28813,7 +28839,7 @@ paths: - date additionalProperties: true examples: - default: &313 + default: &308 value: - date: '2024-06-24' total_active_users: 24 @@ -28912,10 +28938,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *106 + '500': *105 '403': *29 '404': *6 - '422': &314 + '422': &309 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -28942,12 +28968,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *105 - - *170 - - *171 - - *172 - - *173 - - *174 + - *63 + - *179 + - *180 + - *181 + - *182 + - *183 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28985,13 +29011,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *175 - - *176 + - *184 + - *185 - *48 - *40 - *41 - - *177 - - *178 - *17 responses: '200': @@ -29000,9 +29024,9 @@ paths: application/json: schema: type: array - items: *179 + items: *186 examples: - default: *180 + default: *187 '304': *37 '400': *14 '403': *29 @@ -29028,7 +29052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29046,7 +29070,7 @@ paths: type: integer secrets: type: array - items: &181 + items: &188 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29096,7 +29120,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29117,13 +29141,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &484 + schema: &479 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29140,7 +29164,7 @@ paths: - key_id - key examples: - default: &485 + default: &480 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29163,14 +29187,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: Response content: application/json: - schema: *181 + schema: *188 examples: default: value: @@ -29198,8 +29222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -29258,7 +29282,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -29282,8 +29306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -29307,8 +29331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - *19 - *17 responses: @@ -29326,9 +29350,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29349,8 +29373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -29400,8 +29424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -29432,8 +29456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *105 - - *145 + - *63 + - *150 - name: repository_id in: path required: true @@ -29463,7 +29487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -29471,7 +29495,7 @@ paths: application/json: schema: type: array - items: &228 + items: &234 title: Package description: A software package type: object @@ -29521,8 +29545,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *182 - required: *183 + properties: *189 + required: *190 nullable: true created_at: type: string @@ -29541,7 +29565,7 @@ paths: - created_at - updated_at examples: - default: &229 + default: &235 value: - id: 197 name: hello_docker @@ -29619,7 +29643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29629,7 +29653,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: 200-response: value: @@ -29701,7 +29725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29711,7 +29735,7 @@ paths: application/json: schema: type: array - items: &206 + items: &213 title: Organization Invitation description: Organization Invitation type: object @@ -29758,7 +29782,7 @@ paths: - invitation_teams_url - node_id examples: - default: &207 + default: &214 value: - id: 1 login: monalisa @@ -29791,7 +29815,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -29815,7 +29839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *105 + - *63 - *17 - *19 responses: @@ -29825,7 +29849,7 @@ paths: application/json: schema: type: array - items: &184 + items: &191 title: Org Hook description: Org Hook type: object @@ -29913,7 +29937,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -29936,7 +29960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *105 + - *63 requestBody: required: true content: @@ -29996,9 +30020,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: - default: &185 + default: &192 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30045,8 +30069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *105 - - &186 + - *63 + - &193 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -30059,9 +30083,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: - default: *185 + default: *192 '404': *6 x-github: githubCloudOnly: false @@ -30088,8 +30112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 requestBody: required: false content: @@ -30134,7 +30158,7 @@ paths: description: Response content: application/json: - schema: *184 + schema: *191 examples: default: value: @@ -30175,8 +30199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 responses: '204': description: Response @@ -30203,8 +30227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *105 - - *186 + - *63 + - *193 responses: '200': description: Response @@ -30234,8 +30258,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *105 - - *186 + - *63 + - *193 requestBody: required: false content: @@ -30285,10 +30309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *17 - - *187 + - *194 responses: '200': description: Response @@ -30296,9 +30320,9 @@ paths: application/json: schema: type: array - items: *188 + items: *195 examples: - default: *189 + default: *196 '400': *14 '422': *15 x-github: @@ -30323,17 +30347,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *197 examples: - default: *191 + default: *198 '400': *14 '422': *15 x-github: @@ -30358,8 +30382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 - *16 responses: '202': *39 @@ -30388,8 +30412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *105 - - *186 + - *63 + - *193 responses: '204': description: Response @@ -30411,8 +30435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *105 - - &196 + - *63 + - &203 name: actor_type in: path description: The type of the actor @@ -30425,14 +30449,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &197 + - &204 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &192 + - &199 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -30440,7 +30464,7 @@ paths: required: true schema: type: string - - &193 + - &200 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -30533,13 +30557,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *105 - - *192 - - *193 + - *63 + - *199 + - *200 - *19 - *17 - *48 - - &202 + - &209 name: sort description: The property to sort the results by. in: query @@ -30617,15 +30641,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *105 - - *192 - - *193 + - *63 + - *199 + - *200 responses: '200': description: Response content: application/json: - schema: &194 + schema: &201 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30641,7 +30665,7 @@ paths: type: integer format: int64 examples: - default: &195 + default: &202 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30661,24 +30685,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *105 - - &198 + - *63 + - &205 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *192 - - *193 + - *199 + - *200 responses: '200': description: Response content: application/json: - schema: *194 + schema: *201 examples: - default: *195 + default: *202 x-github: enabledForGitHubApps: true category: orgs @@ -30696,19 +30720,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *105 - - *192 - - *193 - - *196 - - *197 + - *63 + - *199 + - *200 + - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *194 + schema: *201 examples: - default: *195 + default: *202 x-github: enabledForGitHubApps: true category: orgs @@ -30725,10 +30749,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *105 - - *192 - - *193 - - &199 + - *63 + - *199 + - *200 + - &206 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30741,7 +30765,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &207 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30757,7 +30781,7 @@ paths: type: integer format: int64 examples: - default: &201 + default: &208 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30793,19 +30817,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *105 - - *198 - - *192 - - *193 + - *63 + - *205 - *199 + - *200 + - *206 responses: '200': description: Response content: application/json: - schema: *200 + schema: *207 examples: - default: *201 + default: *208 x-github: enabledForGitHubApps: true category: orgs @@ -30822,20 +30846,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *105 - - *196 - - *197 - - *192 - - *193 + - *63 + - *203 + - *204 - *199 + - *200 + - *206 responses: '200': description: Response content: application/json: - schema: *200 + schema: *207 examples: - default: *201 + default: *208 x-github: enabledForGitHubApps: true category: orgs @@ -30852,14 +30876,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *105 - - *198 - - *192 - - *193 + - *63 + - *205 + - *199 + - *200 - *19 - *17 - *48 - - *202 + - *209 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30932,7 +30956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *105 + - *63 responses: '200': description: Response @@ -30940,7 +30964,7 @@ paths: application/json: schema: *22 examples: - default: &523 + default: &518 value: id: 1 account: @@ -31009,7 +31033,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -31079,7 +31103,7 @@ paths: suspended_at: suspended_by: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31098,7 +31122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -31106,12 +31130,12 @@ paths: application/json: schema: anyOf: - - &204 + - &211 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &203 + limit: &210 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31136,7 +31160,7 @@ paths: properties: {} additionalProperties: false examples: - default: &205 + default: &212 value: limit: collaborators_only origin: organization @@ -31160,18 +31184,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: application/json: - schema: &524 + schema: &519 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *203 + limit: *210 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31195,9 +31219,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: - default: *205 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -31215,7 +31239,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -31239,7 +31263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *105 + - *63 - *17 - *19 - name: role @@ -31273,11 +31297,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31298,7 +31322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *105 + - *63 requestBody: required: false content: @@ -31352,7 +31376,7 @@ paths: description: Response content: application/json: - schema: *206 + schema: *213 examples: default: value: @@ -31406,8 +31430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *105 - - &208 + - *63 + - &215 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31437,8 +31461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *105 - - *208 + - *63 + - *215 - *17 - *19 responses: @@ -31448,9 +31472,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: &227 + default: &233 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31466,7 +31490,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31485,7 +31509,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -31493,7 +31517,7 @@ paths: application/json: schema: type: array - items: *209 + items: *216 examples: default: value: @@ -31531,7 +31555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -31578,9 +31602,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *216 examples: - default: &210 + default: &217 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31612,8 +31636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *105 - - &211 + - *63 + - &218 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31666,9 +31690,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *216 examples: - default: *210 + default: *217 '404': *6 '422': *7 x-github: @@ -31692,8 +31716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *105 - - *211 + - *63 + - *218 responses: '204': description: Response @@ -31726,7 +31750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *105 + - *63 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31756,7 +31780,7 @@ paths: - closed - all default: open - - *212 + - *219 - name: type description: Can be the name of an issue type. in: query @@ -31775,7 +31799,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -31785,11 +31809,11 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *213 + default: *220 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -31809,7 +31833,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *105 + - *63 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31847,9 +31871,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -31867,8 +31891,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response if requester is an organization member and user is @@ -31902,8 +31926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -31929,8 +31953,8 @@ paths: parameters: - *17 - *19 - - *105 - *63 + - *59 responses: '200': description: Response @@ -31946,11 +31970,11 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: - default: *215 + default: *222 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -31973,9 +31997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *105 - *63 - - &216 + - *59 + - &223 name: codespace_name in: path required: true @@ -31985,7 +32009,7 @@ paths: responses: '202': *39 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32008,17 +32032,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *105 - *63 - - *216 + - *59 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: &451 + default: &446 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32160,7 +32184,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32191,14 +32215,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *105 - *63 + - *59 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *217 + schema: *224 examples: default: value: @@ -32242,7 +32266,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -32267,14 +32291,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '200': description: Response content: application/json: - schema: &219 + schema: &225 title: Org Membership description: Org Membership type: object @@ -32318,7 +32342,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *218 + organization: *61 user: title: Simple User description: A GitHub user. @@ -32341,7 +32365,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &220 + response-if-user-has-an-active-admin-membership-with-organization: &226 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32409,8 +32433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 requestBody: required: false content: @@ -32438,9 +32462,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - response-if-user-already-had-membership-with-organization: *220 + response-if-user-already-had-membership-with-organization: *226 '422': *15 '403': *29 x-github: @@ -32464,8 +32488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -32490,7 +32514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *105 + - *63 - *17 - *19 - name: exclude @@ -32511,7 +32535,7 @@ paths: application/json: schema: type: array - items: &221 + items: &227 title: Migration description: A migration. type: object @@ -32552,7 +32576,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *67 + items: *66 url: type: string format: uri @@ -32748,7 +32772,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32764,7 +32788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *105 + - *63 requestBody: required: true content: @@ -32840,7 +32864,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -33018,8 +33042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *105 - - &222 + - *63 + - &228 name: migration_id description: The unique identifier of the migration. in: path @@ -33046,7 +33070,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -33215,8 +33239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *105 - - *222 + - *63 + - *228 responses: '302': description: Response @@ -33237,8 +33261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *105 - - *222 + - *63 + - *228 responses: '204': description: Response @@ -33261,9 +33285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *105 - - *222 - - &671 + - *63 + - *228 + - &676 name: repo_name description: repo_name parameter in: path @@ -33290,8 +33314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *105 - - *222 + - *63 + - *228 - *17 - *19 responses: @@ -33301,9 +33325,9 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: &234 + default: &240 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33414,7 +33438,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -33440,7 +33464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response - list of organization roles @@ -33456,7 +33480,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &224 + items: &230 title: Organization Role description: Organization roles type: object @@ -33603,8 +33627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -33629,9 +33653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *105 - - *65 - - &223 + - *63 + - *64 + - &229 name: role_id description: The unique identifier of the role. in: path @@ -33666,9 +33690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *105 - - *65 - - *223 + - *63 + - *64 + - *229 responses: '204': description: Response @@ -33693,8 +33717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -33719,9 +33743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *105 - *63 - - *223 + - *59 + - *229 responses: '204': description: Response @@ -33751,9 +33775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *105 - *63 - - *223 + - *59 + - *229 responses: '204': description: Response @@ -33781,14 +33805,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: default: value: @@ -33838,8 +33862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 - *17 - *19 responses: @@ -33917,8 +33941,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 nullable: true type: description: The ownership type of the team @@ -33950,9 +33974,9 @@ paths: - type - parent examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '404': description: Response if the organization or role does not exist. '422': @@ -33979,8 +34003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *105 - - *223 + - *63 + - *229 - *17 - *19 responses: @@ -34008,13 +34032,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &308 + items: &303 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 name: nullable: true type: string @@ -34109,9 +34133,9 @@ paths: - type - url examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': description: Response if the organization or role does not exist. '422': @@ -34133,7 +34157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *105 + - *63 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -34160,9 +34184,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34185,8 +34209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *105 - *63 + - *59 requestBody: required: false content: @@ -34243,8 +34267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -34301,8 +34325,8 @@ paths: - docker - nuget - container - - *105 - - &673 + - *63 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34338,12 +34362,12 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *229 + default: *235 '403': *29 '401': *25 - '400': &675 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34365,7 +34389,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &230 + - &236 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -34383,20 +34407,20 @@ paths: - docker - nuget - container - - &231 + - &237 name: package_name description: The name of the package. in: path required: true schema: type: string - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -34448,9 +34472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 responses: '204': description: Response @@ -34482,9 +34506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 - name: token description: package token schema: @@ -34516,9 +34540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *230 - - *231 - - *105 + - *236 + - *237 + - *63 - *19 - *17 - name: state @@ -34538,7 +34562,7 @@ paths: application/json: schema: type: array - items: &232 + items: &238 title: Package Version description: A version of a software package type: object @@ -34663,10 +34687,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - &233 + - *236 + - *237 + - *63 + - &239 name: package_version_id description: Unique identifier of the package version. in: path @@ -34678,7 +34702,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -34714,10 +34738,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - *233 + - *236 + - *237 + - *63 + - *239 responses: '204': description: Response @@ -34749,10 +34773,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *230 - - *231 - - *105 - - *233 + - *236 + - *237 + - *63 + - *239 responses: '204': description: Response @@ -34779,10 +34803,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *105 + - *63 - *17 - *19 - - &235 + - &241 name: sort description: The property by which to sort the results. in: query @@ -34793,7 +34817,7 @@ paths: - created_at default: created_at - *48 - - &236 + - &242 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34804,7 +34828,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &237 + - &243 name: repository description: The name of the repository to use to filter the results. in: query @@ -34812,7 +34836,7 @@ paths: schema: type: string example: Hello-World - - &238 + - &244 name: permission description: The permission to use to filter the results. in: query @@ -34820,7 +34844,7 @@ paths: schema: type: string example: issues_read - - &239 + - &245 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34830,7 +34854,7 @@ paths: schema: type: string format: date-time - - &240 + - &246 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34840,7 +34864,7 @@ paths: schema: type: string format: date-time - - &241 + - &247 name: token_id description: The ID of the token in: query @@ -34852,7 +34876,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -34984,7 +35008,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35004,7 +35028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *105 + - *63 requestBody: required: true content: @@ -35045,7 +35069,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -35070,7 +35094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *105 + - *63 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35106,11 +35130,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35131,7 +35155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *105 + - *63 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35142,7 +35166,7 @@ paths: - *17 - *19 responses: - '500': *106 + '500': *105 '404': *6 '403': *29 '200': @@ -35151,11 +35175,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35176,19 +35200,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *105 + - *63 - *17 - *19 - - *235 - - *48 - - *236 - - *237 - - *238 - - *239 - - *240 - *241 + - *48 + - *242 + - *243 + - *244 + - *245 + - *246 + - *247 responses: - '500': *106 + '500': *105 '422': *15 '404': *6 '403': *29 @@ -35315,7 +35339,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35335,7 +35359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *105 + - *63 requestBody: required: true content: @@ -35370,7 +35394,7 @@ paths: - 1296269 - 1296280 responses: - '500': *106 + '500': *105 '404': *6 '202': *39 '403': *29 @@ -35395,7 +35419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *105 + - *63 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35423,9 +35447,9 @@ paths: value: action: revoke responses: - '500': *106 + '500': *105 '404': *6 - '204': *163 + '204': *172 '403': *29 '422': *15 x-github: @@ -35447,7 +35471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *105 + - *63 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35457,7 +35481,7 @@ paths: - *17 - *19 responses: - '500': *106 + '500': *105 '404': *6 '403': *29 '200': @@ -35466,11 +35490,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35492,7 +35516,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -35510,7 +35534,7 @@ paths: type: integer configurations: type: array - items: &242 + items: &248 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35576,7 +35600,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *58 + Link: *54 '400': *14 '404': *6 x-github: @@ -35598,7 +35622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -35763,7 +35787,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &243 + org-private-registry-with-selected-visibility: &249 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35804,7 +35828,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -35830,7 +35854,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -35852,16 +35876,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 '404': *6 x-github: githubCloudOnly: false @@ -35882,8 +35906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 requestBody: required: true content: @@ -35978,8 +36002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *105 - - *145 + - *63 + - *150 responses: '204': description: Response @@ -36004,7 +36028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *105 + - *63 - name: state description: Indicates the state of the projects to return. in: query @@ -36025,7 +36049,7 @@ paths: application/json: schema: type: array - items: &244 + items: &250 title: Project description: Projects are a way to organize columns and cards of work. @@ -36149,7 +36173,7 @@ paths: organization_permission: write private: true headers: - Link: *58 + Link: *54 '422': *7 x-github: githubCloudOnly: false @@ -36172,7 +36196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *105 + - *63 requestBody: required: true content: @@ -36198,7 +36222,7 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: default: value: @@ -36236,7 +36260,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &336 + '410': &331 description: Gone content: application/json: @@ -36262,7 +36286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *105 + - *63 - name: q description: Limit results to projects of the specified type. in: query @@ -36279,7 +36303,7 @@ paths: application/json: schema: type: array - items: &245 + items: &251 title: Projects v2 Project description: A projects v2 project type: object @@ -36349,7 +36373,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &755 + properties: &759 id: type: number description: The unique identifier of the status update. @@ -36397,7 +36421,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &756 + required: &760 - id - node_id - created_at @@ -36422,7 +36446,7 @@ paths: - deleted_at - deleted_by examples: - default: &246 + default: &252 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -36505,7 +36529,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36525,24 +36549,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &247 + - &253 name: project_number description: The project's number. in: path required: true schema: type: integer - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36562,8 +36586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *247 - - *105 + - *253 + - *63 - *17 - *40 - *41 @@ -36574,7 +36598,7 @@ paths: application/json: schema: type: array - items: &248 + items: &254 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -36721,7 +36745,7 @@ paths: - updated_at - project_url examples: - default: &249 + default: &255 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36744,7 +36768,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36764,25 +36788,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *247 - - &692 + - *253 + - &696 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *248 + schema: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -36803,8 +36827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *247 - - *105 + - *253 + - *63 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -36813,16 +36837,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - *40 - *41 - *17 @@ -36833,7 +36860,7 @@ paths: application/json: schema: type: array - items: &255 + items: &261 title: Projects v2 Item description: An item belonging to a project type: object @@ -36849,7 +36876,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &253 + content_type: &259 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -36899,7 +36926,7 @@ paths: - updated_at - archived_at examples: - default: &256 + default: &262 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -37573,7 +37600,7 @@ paths: type: sub_issues_progress value: headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -37593,8 +37620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *105 - - *247 + - *63 + - *253 requestBody: required: true description: Details of the item to add to the project. @@ -37631,7 +37658,7 @@ paths: description: Response content: application/json: - schema: &693 + schema: &697 title: Projects v2 Item description: An item belonging to a project type: object @@ -37644,8 +37671,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *71 - - &466 + - *70 + - &461 title: Pull Request Simple description: Pull Request Simple type: object @@ -37751,8 +37778,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true active_lock_reason: type: string @@ -37797,7 +37824,7 @@ paths: nullable: true requested_teams: type: array - items: *169 + items: *178 nullable: true head: type: object @@ -37806,7 +37833,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: @@ -37829,7 +37856,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: @@ -37848,7 +37875,7 @@ paths: _links: type: object properties: - comments: &252 + comments: &258 title: Link description: Hypermedia Link type: object @@ -37857,13 +37884,13 @@ paths: type: string required: - href - commits: *252 - statuses: *252 - html: *252 - issue: *252 - review_comments: *252 - review_comment: *252 - self: *252 + commits: *258 + statuses: *258 + html: *258 + issue: *258 + review_comments: *258 + review_comment: *258 + self: *258 required: - comments - commits @@ -37873,8 +37900,8 @@ paths: - review_comments - review_comment - self - author_association: *72 - auto_merge: &568 + author_association: *71 + auto_merge: &565 title: Auto merge description: The status of auto merging a pull request. type: object @@ -37976,7 +38003,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *253 + content_type: *259 creator: *4 created_at: type: string @@ -38009,7 +38036,7 @@ paths: - updated_at - archived_at examples: - issue: &254 + issue: &260 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -38064,7 +38091,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *254 + pull_request: *260 '304': *37 '403': *29 '401': *25 @@ -38084,9 +38111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *247 - - *105 - - &257 + - *253 + - *63 + - &263 name: item_id description: The unique identifier of the project item. in: path @@ -38094,26 +38121,29 @@ paths: schema: type: integer - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *255 + schema: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -38132,9 +38162,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *247 - - *105 - - *257 + - *253 + - *63 + - *263 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -38204,13 +38234,13 @@ paths: description: Response content: application/json: - schema: *255 + schema: *261 examples: - text_field: *256 - number_field: *256 - date_field: *256 - single_select_field: *256 - iteration_field: *256 + text_field: *262 + number_field: *262 + date_field: *262 + single_select_field: *262 + iteration_field: *262 '401': *25 '403': *29 '404': *6 @@ -38230,9 +38260,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *247 - - *105 - - *257 + - *253 + - *63 + - *263 responses: '204': description: Response @@ -38256,7 +38286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response @@ -38264,7 +38294,7 @@ paths: application/json: schema: type: array - items: &258 + items: &264 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -38330,7 +38360,7 @@ paths: - property_name - value_type examples: - default: &259 + default: &265 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38378,7 +38408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -38389,7 +38419,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *258 + items: *264 minItems: 1 maxItems: 100 required: @@ -38419,9 +38449,9 @@ paths: application/json: schema: type: array - items: *258 + items: *264 examples: - default: *259 + default: *265 '403': *29 '404': *6 x-github: @@ -38442,8 +38472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *105 - - &260 + - *63 + - &266 name: custom_property_name description: The custom property name in: path @@ -38455,9 +38485,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *264 examples: - default: &261 + default: &267 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38491,8 +38521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *105 - - *260 + - *63 + - *266 requestBody: required: true content: @@ -38561,9 +38591,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *264 examples: - default: *261 + default: *267 '403': *29 '404': *6 x-github: @@ -38586,10 +38616,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *105 - - *260 + - *63 + - *266 responses: - '204': *163 + '204': *172 '403': *29 '404': *6 x-github: @@ -38610,7 +38640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *105 + - *63 - *17 - *19 - name: repository_query @@ -38648,25 +38678,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &262 - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value + items: *104 description: List of custom property names and associated values required: - repository_id @@ -38687,7 +38699,7 @@ paths: - property_name: team value: octocat headers: - Link: *58 + Link: *54 '403': *29 '404': *6 x-github: @@ -38715,7 +38727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *105 + - *63 requestBody: required: true content: @@ -38735,7 +38747,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *262 + items: *104 required: - repository_names - properties @@ -38776,7 +38788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *105 + - *63 - *17 - *19 responses: @@ -38788,9 +38800,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38807,8 +38819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response if user is a public member @@ -38832,8 +38844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -38854,8 +38866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *105 - *63 + - *59 responses: '204': description: Response @@ -38879,7 +38891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *105 + - *63 - name: type description: Specifies the types of repositories you want returned. in: query @@ -38925,11 +38937,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38948,7 +38960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *105 + - *63 requestBody: required: true content: @@ -39129,7 +39141,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &333 title: Full Repository description: Full Repository type: object @@ -39406,8 +39418,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *263 - required: *264 + properties: *268 + required: *269 nullable: true temp_clone_token: type: string @@ -39494,8 +39506,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true organization: title: Simple User @@ -39504,8 +39516,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *67 - source: *67 + parent: *66 + source: *66 forks: type: integer master_branch: @@ -39522,7 +39534,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &471 + properties: &466 url: type: string format: uri @@ -39538,12 +39550,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &472 + required: &467 - url - key - name - html_url - security_and_analysis: *265 + security_and_analysis: *270 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -39627,7 +39639,7 @@ paths: - network_count - subscribers_count examples: - default: &340 + default: &335 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40145,10 +40157,10 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - *17 - *19 - - &591 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40166,7 +40178,7 @@ paths: application/json: schema: type: array - items: &291 + items: &296 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -40201,7 +40213,7 @@ paths: source: type: string description: The name of the source - enforcement: &268 + enforcement: &273 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -40214,7 +40226,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &269 + items: &274 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -40284,7 +40296,7 @@ paths: conditions: nullable: true anyOf: - - &266 + - &271 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -40308,7 +40320,7 @@ paths: match. items: type: string - - &270 + - &275 title: Organization ruleset conditions type: object description: |- @@ -40322,7 +40334,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -40356,7 +40368,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -40378,7 +40390,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *266 + - *271 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -40391,7 +40403,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &267 + items: &272 title: Repository ruleset property targeting definition type: object @@ -40424,17 +40436,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *267 + items: *272 required: - repository_property rules: type: array - items: &592 + items: &589 title: Repository Rule type: object description: A repository rule. oneOf: - - &271 + - &276 title: creation description: Only allow users with bypass permission to create matching refs. @@ -40446,7 +40458,7 @@ paths: type: string enum: - creation - - &272 + - &277 title: update description: Only allow users with bypass permission to update matching refs. @@ -40467,7 +40479,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &273 + - &278 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -40479,7 +40491,7 @@ paths: type: string enum: - deletion - - &274 + - &279 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -40491,7 +40503,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &586 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40569,7 +40581,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &275 + - &280 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -40593,7 +40605,7 @@ paths: type: string required: - required_deployment_environments - - &276 + - &281 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -40605,7 +40617,7 @@ paths: type: string enum: - required_signatures - - &277 + - &282 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -40667,7 +40679,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &278 + - &283 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -40715,7 +40727,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &279 + - &284 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -40727,7 +40739,7 @@ paths: type: string enum: - non_fast_forward - - &280 + - &285 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -40763,7 +40775,7 @@ paths: required: - operator - pattern - - &281 + - &286 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -40799,7 +40811,7 @@ paths: required: - operator - pattern - - &282 + - &287 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -40835,7 +40847,7 @@ paths: required: - operator - pattern - - &283 + - &288 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -40871,7 +40883,7 @@ paths: required: - operator - pattern - - &284 + - &289 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -40907,7 +40919,7 @@ paths: required: - operator - pattern - - &285 + - &290 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -40932,7 +40944,7 @@ paths: type: string required: - restricted_file_paths - - &286 + - &291 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -40956,7 +40968,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &287 + - &292 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -40979,7 +40991,7 @@ paths: type: string required: - restricted_file_extensions - - &288 + - &293 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -41004,7 +41016,7 @@ paths: maximum: 100 required: - max_file_size - - &289 + - &294 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -41054,7 +41066,7 @@ paths: - repository_id required: - workflows - - &290 + - &295 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -41115,7 +41127,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &587 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41176,7 +41188,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -41192,7 +41204,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 requestBody: description: Request body required: true @@ -41213,25 +41225,20 @@ paths: - push - repository default: branch - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *270 + items: *274 + conditions: *275 rules: type: array description: An array of rules within the ruleset. - items: &293 + items: &298 title: Repository Rule type: object description: A repository rule. oneOf: - - *271 - - *272 - - *273 - - *274 - - *275 - *276 - *277 - *278 @@ -41247,6 +41254,11 @@ paths: - *288 - *289 - *290 + - *291 + - *292 + - *293 + - *294 + - *295 required: - name - enforcement @@ -41284,9 +41296,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &292 + default: &297 value: id: 21 name: super cool ruleset @@ -41326,7 +41338,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -41340,8 +41352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *105 - - &593 + - *63 + - &590 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41356,7 +41368,7 @@ paths: in: query schema: type: string - - &594 + - &591 name: time_period description: |- The time period to filter by. @@ -41372,14 +41384,14 @@ paths: - week - month default: day - - &595 + - &592 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41399,7 +41411,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &594 title: Rule Suites description: Response type: array @@ -41454,7 +41466,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &595 value: - id: 21 actor_id: 12 @@ -41478,7 +41490,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41497,8 +41509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *105 - - &599 + - *63 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41514,7 +41526,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &597 title: Rule Suite description: Response type: object @@ -41613,7 +41625,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &598 value: id: 21 actor_id: 12 @@ -41648,7 +41660,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41674,7 +41686,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41686,11 +41698,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 '404': *6 - '500': *106 + '500': *105 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -41706,7 +41718,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41732,16 +41744,16 @@ paths: - tag - push - repository - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *270 + items: *274 + conditions: *275 rules: description: An array of rules within the ruleset. type: array - items: *293 + items: *298 examples: default: value: @@ -41776,11 +41788,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 '404': *6 - '500': *106 + '500': *105 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -41796,7 +41808,7 @@ paths: category: orgs subcategory: rules parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41807,7 +41819,7 @@ paths: '204': description: Response '404': *6 - '500': *106 + '500': *105 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -41819,7 +41831,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *105 + - *63 - *17 - *19 - name: ruleset_id @@ -41835,7 +41847,7 @@ paths: application/json: schema: type: array - items: &294 + items: &299 title: Ruleset version type: object description: The historical version of a ruleset @@ -41859,7 +41871,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &600 value: - version_id: 3 actor: @@ -41877,7 +41889,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41894,7 +41906,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *105 + - *63 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41912,9 +41924,9 @@ paths: description: Response content: application/json: - schema: &604 + schema: &601 allOf: - - *294 + - *299 - type: object required: - state @@ -41961,7 +41973,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41983,15 +41995,53 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *105 - - *295 - - *296 - - *297 - - *298 + - *63 + - &602 + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + - &603 + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default + secret patterns are returned. To return generic patterns, pass the token + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + - &604 + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + - &605 + name: sort + description: The property to sort the results by. `created` means when the + alert was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created - *48 - *19 - *17 - - &605 + - &606 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42001,7 +42051,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42011,10 +42061,42 @@ paths: required: false schema: type: string - - *299 - - *300 - - *301 - - *302 + - &608 + name: validity + in: query + description: A comma-separated list of validities that, when present, will + return alerts that match the validities in this list. Valid options are + `active`, `inactive`, and `unknown`. + required: false + schema: + type: string + - &609 + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts + by the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + - &610 + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts + by the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + - &611 + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false responses: '200': description: Response @@ -42022,13 +42104,593 @@ paths: application/json: schema: type: array - items: *303 + items: + type: object + properties: + number: *158 + created_at: *159 + updated_at: + type: string + description: 'The time that the alert was last updated in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + url: *161 + html_url: *162 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this + alert. + state: &612 + description: Sets the state of the secret scanning alert. You + must provide `resolution` when you set the state to `resolved`. + type: string + enum: + - open + - resolved + resolution: &613 + type: string + description: "**Required when the `state` is `resolved`.** The + reason for resolving the alert." + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: *53 + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected + secret. + nullable: true + push_protection_bypassed_by: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in + ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection + bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this + alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple + repositories in the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert + is base64 encoded + nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &614 + - &616 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &617 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &618 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &619 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &620 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &621 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &622 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &623 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &624 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &625 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &626 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &627 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &628 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true + has_more_locations: + type: boolean + description: A boolean value representing whether or not the + token in the alert was detected in more than one location. + assigned_to: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true examples: - default: *304 + default: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false headers: - Link: *58 + Link: *54 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42053,7 +42715,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *105 + - *63 responses: '200': description: Response @@ -42065,7 +42727,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &306 + pattern_config_version: &301 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -42074,7 +42736,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &305 + items: &300 type: object properties: token_type: @@ -42140,7 +42802,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *305 + items: *300 examples: default: value: @@ -42189,7 +42851,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *105 + - *63 requestBody: required: true content: @@ -42197,7 +42859,7 @@ paths: schema: type: object properties: - pattern_config_version: *306 + pattern_config_version: *301 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -42223,7 +42885,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *306 + custom_pattern_version: *301 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -42277,7 +42939,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *105 + - *63 - *48 - name: sort description: The property to sort the results by. @@ -42321,7 +42983,7 @@ paths: application/json: schema: type: array - items: &627 + items: &632 description: A repository security advisory. type: object properties: @@ -42541,7 +43203,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 credits_detailed: type: array nullable: true @@ -42551,7 +43213,7 @@ paths: type: object properties: user: *4 - type: *307 + type: *302 state: type: string description: The state of the user's acceptance of the @@ -42575,7 +43237,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *169 + items: *178 private_fork: readOnly: true nullable: true @@ -42612,7 +43274,7 @@ paths: - private_fork additionalProperties: false examples: - default: &628 + default: &633 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -42991,7 +43653,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *105 + - *63 responses: '200': description: Response @@ -42999,9 +43661,9 @@ paths: application/json: schema: type: array - items: *308 + items: *303 examples: - default: *227 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43024,8 +43686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -43050,8 +43712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -43080,13 +43742,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &694 + schema: &698 type: object properties: total_minutes_used: @@ -43156,7 +43818,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &695 + default: &699 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -43186,13 +43848,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &696 + schema: &700 type: object properties: total_gigabytes_bandwidth_used: @@ -43210,7 +43872,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &697 + default: &701 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -43236,13 +43898,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: &701 + schema: &705 type: object properties: days_left_in_billing_cycle: @@ -43260,7 +43922,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &702 + default: &706 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -43284,7 +43946,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *105 + - *63 responses: '200': description: Immutable releases settings response @@ -43333,7 +43995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *105 + - *63 responses: '204': description: Response @@ -43390,7 +44052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *105 + - *63 - *19 - *17 responses: @@ -43408,9 +44070,9 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *149 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43429,7 +44091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *105 + - *63 requestBody: required: true content: @@ -43478,8 +44140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -43501,8 +44163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *105 - - *126 + - *63 + - *131 responses: '204': description: Response @@ -43525,7 +44187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *105 + - *63 - *17 - *19 responses: @@ -43543,7 +44205,7 @@ paths: type: integer network_configurations: type: array - items: &309 + items: &304 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -43602,7 +44264,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43621,7 +44283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 + - *63 requestBody: required: true content: @@ -43663,9 +44325,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: &310 + default: &305 value: id: 123456789ABCDEF name: My network configuration @@ -43693,8 +44355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 - - &311 + - *63 + - &306 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -43706,11 +44368,11 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: *310 + default: *305 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43729,8 +44391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *105 - - *311 + - *63 + - *306 requestBody: required: true content: @@ -43769,9 +44431,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *304 examples: - default: *310 + default: *305 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43790,8 +44452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *105 - - *311 + - *63 + - *306 responses: '204': description: Response @@ -43814,7 +44476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *105 + - *63 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -43868,7 +44530,7 @@ paths: subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43898,8 +44560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *105 - - *65 + - *63 + - *64 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -43931,13 +44593,13 @@ paths: application/json: schema: type: array - items: *312 + items: *307 examples: - default: *313 - '500': *106 + default: *308 + '500': *105 '403': *29 '404': *6 - '422': *314 + '422': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43955,7 +44617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *105 + - *63 - *17 - *19 responses: @@ -43965,11 +44627,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '403': *29 x-github: githubCloudOnly: false @@ -43989,7 +44651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *105 + - *63 requestBody: required: true content: @@ -44061,7 +44723,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &310 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -44124,8 +44786,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *225 - required: *226 + properties: *231 + required: *232 nullable: true members_count: type: integer @@ -44388,7 +45050,7 @@ paths: - repos_count - organization examples: - default: &316 + default: &311 value: id: 1 node_id: MDQ6VGVhbTE= @@ -44458,16 +45120,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *105 - - *65 + - *63 + - *64 responses: '200': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 x-github: githubCloudOnly: false @@ -44488,8 +45150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *105 - - *65 + - *63 + - *64 requestBody: required: false content: @@ -44551,16 +45213,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '201': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 '422': *15 '403': *29 @@ -44585,8 +45247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *105 - - *65 + - *63 + - *64 responses: '204': description: Response @@ -44612,8 +45274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *105 - - *65 + - *63 + - *64 - *48 - *17 - *19 @@ -44630,7 +45292,7 @@ paths: application/json: schema: type: array - items: &317 + items: &312 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -44709,7 +45371,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *73 + reactions: *72 required: - author - body @@ -44729,7 +45391,7 @@ paths: - updated_at - url examples: - default: &645 + default: &650 value: - author: login: octocat @@ -44779,7 +45441,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44803,8 +45465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *105 - - *65 + - *63 + - *64 requestBody: required: true content: @@ -44838,9 +45500,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: &318 + default: &313 value: author: login: octocat @@ -44912,9 +45574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *105 - - *65 - - &319 + - *63 + - *64 + - &314 name: discussion_number description: The number that identifies the discussion. in: path @@ -44926,9 +45588,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44950,9 +45612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: false content: @@ -44975,9 +45637,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: &646 + default: &651 value: author: login: octocat @@ -45047,9 +45709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 responses: '204': description: Response @@ -45075,9 +45737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 - *48 - *17 - *19 @@ -45088,7 +45750,7 @@ paths: application/json: schema: type: array - items: &320 + items: &315 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -45145,7 +45807,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *73 + reactions: *72 required: - author - body @@ -45160,7 +45822,7 @@ paths: - updated_at - url examples: - default: &647 + default: &652 value: - author: login: octocat @@ -45204,7 +45866,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45228,9 +45890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: true content: @@ -45252,9 +45914,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: &321 + default: &316 value: author: login: octocat @@ -45320,10 +45982,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - &322 + - *63 + - *64 + - *314 + - &317 name: comment_number description: The number that identifies the comment. in: path @@ -45335,9 +45997,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45359,10 +46021,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 requestBody: required: true content: @@ -45384,9 +46046,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: &648 + default: &653 value: author: login: octocat @@ -45450,10 +46112,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 responses: '204': description: Response @@ -45479,10 +46141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -45508,7 +46170,7 @@ paths: application/json: schema: type: array - items: &323 + items: &318 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -45551,7 +46213,7 @@ paths: - content - created_at examples: - default: &325 + default: &320 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45577,7 +46239,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45601,10 +46263,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *105 - - *65 - - *319 - - *322 + - *63 + - *64 + - *314 + - *317 requestBody: required: true content: @@ -45637,9 +46299,9 @@ paths: team discussion comment content: application/json: - schema: *323 + schema: *318 examples: - default: &324 + default: &319 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45668,9 +46330,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45693,11 +46355,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *105 - - *65 - - *319 - - *322 - - &326 + - *63 + - *64 + - *314 + - *317 + - &321 name: reaction_id description: The unique identifier of the reaction. in: path @@ -45729,9 +46391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -45757,11 +46419,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45785,9 +46447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *105 - - *65 - - *319 + - *63 + - *64 + - *314 requestBody: required: true content: @@ -45819,16 +46481,16 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45851,10 +46513,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *105 - - *65 - - *319 - - *326 + - *63 + - *64 + - *314 + - *321 responses: '204': description: Response @@ -45878,8 +46540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -45889,11 +46551,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45913,8 +46575,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *105 - - *65 + - *63 + - *64 - name: role description: Filters members returned by their role in the team. in: query @@ -45937,9 +46599,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45967,15 +46629,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 responses: '200': description: Response content: application/json: - schema: &327 + schema: &322 title: Team Membership description: Team Membership type: object @@ -46002,7 +46664,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &649 + response-if-user-is-a-team-maintainer: &654 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46038,9 +46700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 requestBody: required: false content: @@ -46065,9 +46727,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-users-membership-with-team-is-now-pending: &650 + response-if-users-membership-with-team-is-now-pending: &655 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46102,9 +46764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *105 - - *65 - *63 + - *64 + - *59 responses: '204': description: Response @@ -46129,8 +46791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -46140,7 +46802,7 @@ paths: application/json: schema: type: array - items: &328 + items: &323 title: Team Project description: A team's access to a project. type: object @@ -46208,7 +46870,7 @@ paths: - updated_at - permissions examples: - default: &651 + default: &656 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46248,7 +46910,7 @@ paths: write: true admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46271,9 +46933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *105 - - *65 - - &329 + - *63 + - *64 + - &324 name: project_id description: The unique identifier of the project. in: path @@ -46285,9 +46947,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *323 examples: - default: &652 + default: &657 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46349,9 +47011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *105 - - *65 - - *329 + - *63 + - *64 + - *324 requestBody: required: false content: @@ -46417,9 +47079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *105 - - *65 - - *329 + - *63 + - *64 + - *324 responses: '204': description: Response @@ -46446,8 +47108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -46457,11 +47119,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46488,16 +47150,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &653 + schema: &658 title: Team Repository description: A team's access to a repository. type: object @@ -46520,8 +47182,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true forks: type: integer @@ -47066,10 +47728,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 requestBody: required: false content: @@ -47114,10 +47776,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *105 - - *65 - - *330 - - *331 + - *63 + - *64 + - *325 + - *326 responses: '204': description: Response @@ -47141,8 +47803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *105 - - *65 + - *63 + - *64 - *17 - *19 responses: @@ -47152,9 +47814,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - response-if-child-teams-exist: &654 + response-if-child-teams-exist: &659 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47182,7 +47844,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47207,7 +47869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *105 + - *63 - name: security_product in: path description: The security feature to enable or disable. @@ -47281,7 +47943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &332 + - &327 name: column_id description: The unique identifier of the column. in: path @@ -47293,7 +47955,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &328 title: Project Column description: Project columns contain cards of work. type: object @@ -47339,7 +48001,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &329 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -47374,7 +48036,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *332 + - *327 requestBody: required: true content: @@ -47398,9 +48060,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: - default: *334 + default: *329 '304': *37 '403': *29 '401': *25 @@ -47425,7 +48087,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *332 + - *327 responses: '204': description: Response @@ -47454,7 +48116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *332 + - *327 requestBody: required: true content: @@ -47514,15 +48176,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *329 + - *324 responses: '200': description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: &335 + default: &330 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -47579,7 +48241,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *329 + - *324 requestBody: required: false content: @@ -47625,9 +48287,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *335 + default: *330 '404': description: Not Found if the authenticated user does not have access to the project @@ -47648,7 +48310,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -47671,7 +48333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *329 + - *324 responses: '204': description: Delete Success @@ -47692,7 +48354,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *331 '404': *6 x-github: githubCloudOnly: false @@ -47716,7 +48378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *329 + - *324 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -47743,9 +48405,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 '422': *15 '304': *37 @@ -47773,8 +48435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *329 - - *63 + - *324 + - *59 requestBody: required: false content: @@ -47826,8 +48488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *329 - - *63 + - *324 + - *59 responses: '204': description: Response @@ -47858,8 +48520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *329 - - *63 + - *324 + - *59 responses: '200': description: Response @@ -47932,7 +48594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *329 + - *324 - *17 - *19 responses: @@ -47942,7 +48604,7 @@ paths: application/json: schema: type: array - items: *333 + items: *328 examples: default: value: @@ -47955,7 +48617,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -47980,7 +48642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *329 + - *324 requestBody: required: true content: @@ -48003,7 +48665,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *328 examples: default: value: @@ -48068,7 +48730,7 @@ paths: resources: type: object properties: - core: &337 + core: &332 title: Rate Limit type: object properties: @@ -48085,21 +48747,21 @@ paths: - remaining - reset - used - graphql: *337 - search: *337 - code_search: *337 - source_import: *337 - integration_manifest: *337 - code_scanning_upload: *337 - actions_runner_registration: *337 - scim: *337 - dependency_snapshots: *337 - dependency_sbom: *337 - code_scanning_autofix: *337 + graphql: *332 + search: *332 + code_search: *332 + source_import: *332 + integration_manifest: *332 + code_scanning_upload: *332 + actions_runner_registration: *332 + scim: *332 + dependency_snapshots: *332 + dependency_sbom: *332 + code_scanning_autofix: *332 required: - core - search - rate: *337 + rate: *332 required: - rate - resources @@ -48204,14 +48866,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *338 + schema: *333 examples: default-response: summary: Default response @@ -48712,7 +49374,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *339 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48730,8 +49392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -48978,10 +49640,10 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 - '307': &341 + default: *335 + '307': &336 description: Temporary Redirect content: application/json: @@ -49010,8 +49672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -49033,7 +49695,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *341 + '307': *336 '404': *6 '409': *47 x-github: @@ -49057,11 +49719,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - - &372 + - &367 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49084,7 +49746,7 @@ paths: type: integer artifacts: type: array - items: &342 + items: &337 title: Artifact description: An artifact type: object @@ -49162,7 +49824,7 @@ paths: - expires_at - updated_at examples: - default: &373 + default: &368 value: total_count: 2 artifacts: @@ -49201,7 +49863,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49223,9 +49885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *330 - - *331 - - &343 + - *325 + - *326 + - &338 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49237,7 +49899,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *337 examples: default: value: @@ -49275,9 +49937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *330 - - *331 - - *343 + - *325 + - *326 + - *338 responses: '204': description: Response @@ -49301,9 +49963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *330 - - *331 - - *343 + - *325 + - *326 + - *338 - name: archive_format in: path required: true @@ -49317,7 +49979,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49340,14 +50002,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *344 + schema: *339 examples: default: value: @@ -49373,11 +50035,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - - &345 + - &340 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -49411,7 +50073,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &341 title: Repository actions caches description: Repository actions caches type: object @@ -49453,7 +50115,7 @@ paths: - total_count - actions_caches examples: - default: &347 + default: &342 value: total_count: 1 actions_caches: @@ -49465,7 +50127,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49485,23 +50147,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *330 - - *331 + - *325 + - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *345 + - *340 responses: '200': description: Response content: application/json: - schema: *346 + schema: *341 examples: - default: *347 + default: *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49521,8 +50183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *330 - - *331 + - *325 + - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49553,9 +50215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *330 - - *331 - - &348 + - *325 + - *326 + - &343 name: job_id description: The unique identifier of the job. in: path @@ -49567,7 +50229,7 @@ paths: description: Response content: application/json: - schema: &376 + schema: &371 title: Job description: Information of a job execution in a workflow run type: object @@ -49874,9 +50536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *330 - - *331 - - *348 + - *325 + - *326 + - *343 responses: '302': description: Response @@ -49904,9 +50566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *330 - - *331 - - *348 + - *325 + - *326 + - *343 requestBody: required: false content: @@ -49927,7 +50589,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -49951,8 +50613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Status response @@ -50002,8 +50664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -50037,7 +50699,7 @@ paths: description: Empty response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -50066,8 +50728,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -50085,7 +50747,7 @@ paths: type: integer secrets: type: array - items: &378 + items: &373 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50105,7 +50767,7 @@ paths: - created_at - updated_at examples: - default: &379 + default: &374 value: total_count: 2 secrets: @@ -50116,7 +50778,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50138,9 +50800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *330 - - *331 - - *349 + - *325 + - *326 + - *344 - *19 responses: '200': @@ -50157,7 +50819,7 @@ paths: type: integer variables: type: array - items: &382 + items: &377 title: Actions Variable type: object properties: @@ -50187,7 +50849,7 @@ paths: - created_at - updated_at examples: - default: &383 + default: &378 value: total_count: 2 variables: @@ -50200,7 +50862,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50220,8 +50882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -50230,12 +50892,12 @@ paths: schema: type: object properties: - enabled: &351 + enabled: &346 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *122 - selected_actions_url: *350 - sha_pinning_required: *123 + allowed_actions: *127 + selected_actions_url: *345 + sha_pinning_required: *128 required: - enabled examples: @@ -50263,8 +50925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50275,9 +50937,9 @@ paths: schema: type: object properties: - enabled: *351 - allowed_actions: *122 - sha_pinning_required: *123 + enabled: *346 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled examples: @@ -50307,14 +50969,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &352 + schema: &347 type: object properties: access_level: @@ -50331,7 +50993,7 @@ paths: required: - access_level examples: - default: &353 + default: &348 value: access_level: organization x-github: @@ -50355,15 +51017,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *352 + schema: *347 examples: - default: *353 + default: *348 responses: '204': description: Response @@ -50387,14 +51049,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: default: value: @@ -50418,8 +51080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Empty response for successful settings update @@ -50429,7 +51091,7 @@ paths: required: true content: application/json: - schema: *355 + schema: *350 examples: default: summary: Set retention days @@ -50453,16 +51115,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *124 + schema: *129 examples: - default: *356 + default: *351 '404': *6 x-github: enabledForGitHubApps: true @@ -50481,8 +51143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50492,7 +51154,7 @@ paths: required: true content: application/json: - schema: *124 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -50516,16 +51178,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *357 + schema: *352 examples: - default: *125 + default: *130 '403': *29 '404': *6 x-github: @@ -50545,15 +51207,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *358 + schema: *353 examples: - default: *125 + default: *130 responses: '204': description: Empty response for successful settings update @@ -50577,16 +51239,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *127 + schema: *132 examples: - default: *128 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50605,8 +51267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -50614,9 +51276,9 @@ paths: required: false content: application/json: - schema: *127 + schema: *132 examples: - selected_actions: *128 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50638,16 +51300,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *359 + schema: *354 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50668,8 +51330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Success response @@ -50680,9 +51342,9 @@ paths: required: true content: application/json: - schema: *360 + schema: *355 examples: - default: *132 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50709,8 +51371,8 @@ paths: in: query schema: type: string - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -50728,11 +51390,11 @@ paths: type: integer runners: type: array - items: *139 + items: *144 examples: - default: *140 + default: *145 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50754,8 +51416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -50763,9 +51425,9 @@ paths: application/json: schema: type: array - items: *361 + items: *356 examples: - default: *362 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50787,8 +51449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -50831,7 +51493,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *363 + '201': *358 '404': *6 '422': *7 '409': *47 @@ -50862,16 +51524,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: *364 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50899,16 +51561,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response content: application/json: - schema: *141 + schema: *146 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50930,17 +51592,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: '200': description: Response content: application/json: - schema: *139 + schema: *144 examples: - default: *366 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50961,9 +51623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: '204': description: Response @@ -50989,11 +51651,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: - '200': *143 + '200': *148 '404': *6 x-github: githubCloudOnly: false @@ -51015,9 +51677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 requestBody: required: true content: @@ -51041,7 +51703,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51065,9 +51727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 requestBody: required: true content: @@ -51092,7 +51754,7 @@ paths: - gpu - accelerated responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51116,11 +51778,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 + - *325 + - *326 + - *143 responses: - '200': *367 + '200': *362 '404': *6 x-github: githubCloudOnly: false @@ -51147,12 +51809,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *330 - - *331 - - *138 - - *368 + - *325 + - *326 + - *143 + - *363 responses: - '200': *143 + '200': *148 '404': *6 '422': *7 x-github: @@ -51178,9 +51840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *330 - - *331 - - &386 + - *325 + - *326 + - &381 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -51188,7 +51850,7 @@ paths: required: false schema: type: string - - &387 + - &382 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51196,7 +51858,7 @@ paths: required: false schema: type: string - - &388 + - &383 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51205,7 +51867,7 @@ paths: required: false schema: type: string - - &389 + - &384 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -51232,7 +51894,7 @@ paths: - pending - *17 - *19 - - &390 + - &385 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -51241,7 +51903,7 @@ paths: schema: type: string format: date-time - - &369 + - &364 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51250,13 +51912,13 @@ paths: schema: type: boolean default: false - - &391 + - &386 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &392 + - &387 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51279,7 +51941,7 @@ paths: type: integer workflow_runs: type: array - items: &370 + items: &365 title: Workflow Run description: An invocation of a workflow type: object @@ -51374,7 +52036,7 @@ paths: that triggered the run. type: array nullable: true - items: *76 + items: *75 created_at: type: string format: date-time @@ -51427,7 +52089,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &414 + properties: &409 id: type: string description: SHA for the commit @@ -51478,7 +52140,7 @@ paths: - name - email nullable: true - required: &415 + required: &410 - id - tree_id - message @@ -51486,8 +52148,8 @@ paths: - author - committer nullable: true - repository: *137 - head_repository: *137 + repository: *142 + head_repository: *142 head_repository_id: type: integer example: 5 @@ -51525,7 +52187,7 @@ paths: - workflow_url - pull_requests examples: - default: &393 + default: &388 value: total_count: 1 workflow_runs: @@ -51739,7 +52401,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51761,24 +52423,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *330 - - *331 - - &371 + - *325 + - *326 + - &366 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *369 + - *364 responses: '200': description: Response content: application/json: - schema: *370 + schema: *365 examples: - default: &374 + default: &369 value: id: 30433642 name: Build @@ -52019,9 +52681,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '204': description: Response @@ -52044,9 +52706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -52165,15 +52827,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52200,12 +52862,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 - *17 - *19 - - *372 + - *367 responses: '200': description: Response @@ -52221,11 +52883,11 @@ paths: type: integer artifacts: type: array - items: *342 + items: *337 examples: - default: *373 + default: *368 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52247,25 +52909,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *330 - - *331 - - *371 - - &375 + - *325 + - *326 + - *366 + - &370 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *369 + - *364 responses: '200': description: Response content: application/json: - schema: *370 + schema: *365 examples: - default: *374 + default: *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52288,10 +52950,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *330 - - *331 - - *371 - - *375 + - *325 + - *326 + - *366 + - *370 - *17 - *19 responses: @@ -52309,9 +52971,9 @@ paths: type: integer jobs: type: array - items: *376 + items: *371 examples: - default: &377 + default: &372 value: total_count: 1 jobs: @@ -52400,7 +53062,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -52424,10 +53086,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *330 - - *331 - - *371 - - *375 + - *325 + - *326 + - *366 + - *370 responses: '302': description: Response @@ -52455,15 +53117,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '202': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52490,9 +53152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: true content: @@ -52559,15 +53221,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '202': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -52594,9 +53256,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -52626,11 +53288,11 @@ paths: type: integer jobs: type: array - items: *376 + items: *371 examples: - default: *377 + default: *372 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52653,9 +53315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '302': description: Response @@ -52682,14 +53344,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '204': description: Response '403': *29 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52711,9 +53373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -52773,7 +53435,7 @@ paths: items: type: object properties: - type: &493 + type: &488 type: string description: The type of reviewer. enum: @@ -52783,7 +53445,7 @@ paths: reviewer: anyOf: - *4 - - *169 + - *178 required: - environment - wait_timer @@ -52858,9 +53520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: true content: @@ -52907,7 +53569,7 @@ paths: application/json: schema: type: array - items: &488 + items: &483 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52995,8 +53657,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -53013,7 +53675,7 @@ paths: - created_at - updated_at examples: - default: &489 + default: &484 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53069,9 +53731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: false content: @@ -53092,7 +53754,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53115,9 +53777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 requestBody: required: false content: @@ -53138,7 +53800,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53170,9 +53832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *330 - - *331 - - *371 + - *325 + - *326 + - *366 responses: '200': description: Response @@ -53309,8 +53971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -53328,11 +53990,11 @@ paths: type: integer secrets: type: array - items: *378 + items: *373 examples: - default: *379 + default: *374 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53355,16 +54017,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *380 + schema: *375 examples: - default: *381 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53386,17 +54048,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *378 + schema: *373 examples: - default: &506 + default: &501 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53422,9 +54084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -53455,7 +54117,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53481,9 +54143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -53508,9 +54170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *330 - - *331 - - *349 + - *325 + - *326 + - *344 - *19 responses: '200': @@ -53527,11 +54189,11 @@ paths: type: integer variables: type: array - items: *382 + items: *377 examples: - default: *383 + default: *378 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53552,8 +54214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -53580,7 +54242,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -53605,17 +54267,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 responses: '200': description: Response content: application/json: - schema: *382 + schema: *377 examples: - default: &507 + default: &502 value: name: USERNAME value: octocat @@ -53641,9 +54303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 requestBody: required: true content: @@ -53685,9 +54347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *330 - - *331 - - *148 + - *325 + - *326 + - *153 responses: '204': description: Response @@ -53712,8 +54374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -53731,7 +54393,7 @@ paths: type: integer workflows: type: array - items: &384 + items: &379 title: Workflow description: A GitHub Actions workflow type: object @@ -53815,7 +54477,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53838,9 +54500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *330 - - *331 - - &385 + - *325 + - *326 + - &380 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53855,7 +54517,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *379 examples: default: value: @@ -53888,9 +54550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53915,9 +54577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53968,9 +54630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '204': description: Response @@ -53997,19 +54659,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *330 - - *331 + - *325 + - *326 + - *380 + - *381 + - *382 + - *383 + - *384 + - *17 + - *19 - *385 + - *364 - *386 - *387 - - *388 - - *389 - - *17 - - *19 - - *390 - - *369 - - *391 - - *392 responses: '200': description: Response @@ -54025,11 +54687,11 @@ paths: type: integer workflow_runs: type: array - items: *370 + items: *365 examples: - default: *393 + default: *388 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54059,9 +54721,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *330 - - *331 - - *385 + - *325 + - *326 + - *380 responses: '200': description: Response @@ -54122,8 +54784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *330 - - *331 + - *325 + - *326 - *48 - *17 - *40 @@ -54268,7 +54930,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '422': *7 x-github: githubCloudOnly: false @@ -54287,8 +54949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -54300,9 +54962,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -54325,8 +54987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *330 - - *331 + - *325 + - *326 - name: assignee in: path required: true @@ -54362,8 +55024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -54475,8 +55137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *40 - *41 @@ -54532,7 +55194,7 @@ paths: initiator: type: string examples: - default: *394 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54552,8 +55214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -54561,7 +55223,7 @@ paths: application/json: schema: type: array - items: &395 + items: &390 title: Autolink reference description: An autolink reference. type: object @@ -54615,8 +55277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -54655,9 +55317,9 @@ paths: description: response content: application/json: - schema: *395 + schema: *390 examples: - default: &396 + default: &391 value: id: 1 key_prefix: TICKET- @@ -54688,9 +55350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *330 - - *331 - - &397 + - *325 + - *326 + - &392 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54702,9 +55364,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: *396 + default: *391 '404': *6 x-github: githubCloudOnly: false @@ -54724,9 +55386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *330 - - *331 - - *397 + - *325 + - *326 + - *392 responses: '204': description: Response @@ -54750,8 +55412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response if Dependabot is enabled @@ -54799,8 +55461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -54821,8 +55483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -54842,8 +55504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *330 - - *331 + - *325 + - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54881,7 +55543,7 @@ paths: - url protected: type: boolean - protection: &399 + protection: &394 title: Branch Protection description: Branch Protection type: object @@ -54923,7 +55585,7 @@ paths: required: - contexts - checks - enforce_admins: &402 + enforce_admins: &397 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54938,7 +55600,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &404 + required_pull_request_reviews: &399 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54959,7 +55621,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *169 + items: *178 apps: description: The list of apps with review dismissal access. @@ -54988,7 +55650,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *169 + items: *178 apps: description: The list of apps allowed to bypass pull request requirements. @@ -55014,7 +55676,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &401 + restrictions: &396 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55077,7 +55739,7 @@ paths: type: string teams: type: array - items: *169 + items: *178 apps: type: array items: @@ -55273,7 +55935,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -55291,9 +55953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *330 - - *331 - - &400 + - *325 + - *326 + - &395 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -55307,14 +55969,14 @@ paths: description: Response content: application/json: - schema: &410 + schema: &405 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &462 + commit: &457 title: Commit description: Commit type: object @@ -55348,7 +56010,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &398 + properties: &393 name: type: string example: '"Chris Wanstrath"' @@ -55363,7 +56025,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true message: type: string @@ -55384,7 +56046,7 @@ paths: required: - sha - url - verification: &513 + verification: &508 title: Verification type: object properties: @@ -55418,12 +56080,12 @@ paths: nullable: true oneOf: - *4 - - *146 + - *151 committer: nullable: true oneOf: - *4 - - *146 + - *151 parents: type: array items: @@ -55454,7 +56116,7 @@ paths: type: integer files: type: array - items: &475 + items: &470 title: Diff Entry description: Diff Entry type: object @@ -55538,7 +56200,7 @@ paths: - self protected: type: boolean - protection: *399 + protection: *394 protection_url: type: string format: uri @@ -55645,7 +56307,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *339 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -55667,15 +56329,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *399 + schema: *394 examples: default: value: @@ -55869,9 +56531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -56126,7 +56788,7 @@ paths: url: type: string format: uri - required_status_checks: &407 + required_status_checks: &402 title: Status Check Policy description: Status Check Policy type: object @@ -56202,7 +56864,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 apps: type: array items: *5 @@ -56220,7 +56882,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 apps: type: array items: *5 @@ -56278,7 +56940,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *401 + restrictions: *396 required_conversation_resolution: type: object properties: @@ -56390,9 +57052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56417,17 +57079,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &403 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56449,17 +57111,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *403 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56478,9 +57140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56505,17 +57167,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *404 + schema: *399 examples: - default: &405 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56611,9 +57273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -56711,9 +57373,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *399 examples: - default: *405 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -56734,9 +57396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56763,17 +57425,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: &406 + default: &401 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56796,17 +57458,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *402 + schema: *397 examples: - default: *406 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -56826,9 +57488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56853,17 +57515,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: &408 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56889,9 +57551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -56943,9 +57605,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *402 examples: - default: *408 + default: *403 '404': *6 '422': *15 x-github: @@ -56967,9 +57629,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -56993,9 +57655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57029,9 +57691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57098,9 +57760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57164,9 +57826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: content: application/json: @@ -57232,15 +57894,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response content: application/json: - schema: *401 + schema: *396 examples: default: value: @@ -57331,9 +57993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '204': description: Response @@ -57356,9 +58018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57368,7 +58030,7 @@ paths: type: array items: *5 examples: - default: &409 + default: &404 value: - id: 1 slug: octoapp @@ -57425,9 +58087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57461,7 +58123,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57482,9 +58144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57518,7 +58180,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57539,9 +58201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57575,7 +58237,7 @@ paths: type: array items: *5 examples: - default: *409 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -57597,9 +58259,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57607,9 +58269,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '404': *6 x-github: githubCloudOnly: false @@ -57629,9 +58291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57667,9 +58329,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57690,9 +58352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: false content: @@ -57728,9 +58390,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57751,9 +58413,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: content: application/json: @@ -57788,9 +58450,9 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 '422': *15 x-github: githubCloudOnly: false @@ -57812,9 +58474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 responses: '200': description: Response @@ -57824,7 +58486,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '404': *6 x-github: githubCloudOnly: false @@ -57848,9 +58510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57883,7 +58545,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -57908,9 +58570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -57943,7 +58605,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -57968,9 +58630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -58003,7 +58665,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '422': *15 x-github: githubCloudOnly: false @@ -58030,9 +58692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 requestBody: required: true content: @@ -58054,7 +58716,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *405 examples: default: value: @@ -58170,8 +58832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -58450,7 +59112,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &406 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58561,16 +59223,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *76 - deployment: &713 + items: *75 + deployment: &717 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58637,8 +59299,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -58850,9 +59512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *330 - - *331 - - &412 + - *325 + - *326 + - &407 name: check_run_id description: The unique identifier of the check run. in: path @@ -58864,9 +59526,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *406 examples: - default: &413 + default: &408 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58966,9 +59628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 requestBody: required: true content: @@ -59208,9 +59870,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *406 examples: - default: *413 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59230,9 +59892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 - *17 - *19 responses: @@ -59307,7 +59969,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59327,15 +59989,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *330 - - *331 - - *412 + - *325 + - *326 + - *407 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -59373,8 +60035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -59396,7 +60058,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &416 + schema: &411 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59460,7 +60122,7 @@ paths: nullable: true pull_requests: type: array - items: *76 + items: *75 nullable: true app: title: GitHub app @@ -59471,9 +60133,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - repository: *137 + properties: *67 + required: *68 + repository: *142 created_at: type: string format: date-time @@ -59482,12 +60144,12 @@ paths: type: string format: date-time nullable: true - head_commit: &739 + head_commit: &743 title: Simple Commit description: A commit. type: object - properties: *414 - required: *415 + properties: *409 + required: *410 latest_check_runs_count: type: integer check_runs_url: @@ -59515,7 +60177,7 @@ paths: - check_runs_url - pull_requests examples: - default: &417 + default: &412 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59806,9 +60468,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59827,8 +60489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -59889,7 +60551,7 @@ paths: required: - app_id - setting - repository: *137 + repository: *142 examples: default: value: @@ -60137,9 +60799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *330 - - *331 - - &418 + - *325 + - *326 + - &413 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60151,9 +60813,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60176,17 +60838,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *330 - - *331 - - *418 - - &468 + - *325 + - *326 + - *413 + - &463 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &469 + - &464 name: status description: Returns check runs with the specified `status`. in: query @@ -60225,9 +60887,9 @@ paths: type: integer check_runs: type: array - items: *411 + items: *406 examples: - default: &470 + default: &465 value: total_count: 1 check_runs: @@ -60309,7 +60971,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60329,15 +60991,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *330 - - *331 - - *418 + - *325 + - *326 + - *413 responses: '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -60364,21 +61026,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *330 - - *331 - - *419 - - *420 + - *325 + - *326 + - *414 + - *415 - *19 - *17 - - &437 + - &432 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *421 - - &438 + schema: *416 + - &433 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60403,13 +61065,13 @@ paths: be returned. in: query required: false - schema: *422 + schema: *417 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *423 + schema: *418 responses: '200': description: Response @@ -60420,14 +61082,14 @@ paths: items: type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: *424 - state: *158 - fixed_at: *154 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: *419 + state: *167 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -60435,12 +61097,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: *425 - dismissed_comment: *426 - rule: *427 - tool: *428 - most_recent_instance: *429 + dismissed_at: *164 + dismissed_reason: *420 + dismissed_comment: *421 + rule: *422 + tool: *423 + most_recent_instance: *424 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60566,14 +61228,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &430 + '403': &425 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60593,9 +61255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *330 - - *331 - - &431 + - *325 + - *326 + - &426 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60603,23 +61265,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *54 + schema: *158 responses: '200': description: Response content: application/json: - schema: &432 + schema: &427 type: object properties: - number: *54 - created_at: *55 - updated_at: *153 - url: *56 - html_url: *57 - instances_url: *424 - state: *158 - fixed_at: *154 + number: *158 + created_at: *159 + updated_at: *160 + url: *161 + html_url: *162 + instances_url: *419 + state: *167 + fixed_at: *163 dismissed_by: title: Simple User description: A GitHub user. @@ -60627,9 +61289,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *155 - dismissed_reason: *425 - dismissed_comment: *426 + dismissed_at: *164 + dismissed_reason: *420 + dismissed_comment: *421 rule: type: object properties: @@ -60683,8 +61345,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *428 - most_recent_instance: *429 + tool: *423 + most_recent_instance: *424 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60783,9 +61445,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60803,9 +61465,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: true content: @@ -60820,8 +61482,8 @@ paths: enum: - open - dismissed - dismissed_reason: *425 - dismissed_comment: *426 + dismissed_reason: *420 + dismissed_comment: *421 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60840,7 +61502,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *427 examples: default: value: @@ -60916,14 +61578,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &436 + '403': &431 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60943,15 +61605,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 responses: '200': description: Response content: application/json: - schema: &433 + schema: &428 type: object properties: status: @@ -60977,13 +61639,13 @@ paths: - description - started_at examples: - default: &434 + default: &429 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &435 + '400': &430 description: Bad Request content: application/json: @@ -60994,9 +61656,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61019,29 +61681,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 responses: '200': description: OK content: application/json: - schema: *433 + schema: *428 examples: - default: *434 + default: *429 '202': description: Accepted content: application/json: - schema: *433 + schema: *428 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *435 + '400': *430 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61051,7 +61713,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61073,9 +61735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: false content: @@ -61120,12 +61782,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *435 - '403': *436 + '400': *430 + '403': *431 '404': *6 '422': description: Unprocessable Entity - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61145,13 +61807,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 - *19 - *17 - - *437 - - *438 + - *432 + - *433 responses: '200': description: Response @@ -61159,7 +61821,7 @@ paths: application/json: schema: type: array - items: *429 + items: *424 examples: default: value: @@ -61198,9 +61860,9 @@ paths: end_column: 50 classifications: - source - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61232,25 +61894,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *330 - - *331 - - *419 - - *420 + - *325 + - *326 + - *414 + - *415 - *19 - *17 - - *438 + - *433 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *421 + schema: *416 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &441 + schema: &436 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -61271,23 +61933,23 @@ paths: application/json: schema: type: array - items: &442 + items: &437 type: object properties: - ref: *421 - commit_sha: &450 + ref: *416 + commit_sha: &445 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *439 + analysis_key: *434 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *440 + category: *435 error: type: string example: error reading field xyz @@ -61311,8 +61973,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *441 - tool: *428 + sarif_id: *436 + tool: *423 deletable: type: boolean warning: @@ -61373,9 +62035,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61409,8 +62071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61423,7 +62085,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: response: summary: application/json response @@ -61477,14 +62139,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *430 + '403': *425 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61564,8 +62226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61618,9 +62280,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *436 + '403': *431 '404': *6 - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61640,8 +62302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -61649,7 +62311,7 @@ paths: application/json: schema: type: array - items: &443 + items: &438 title: CodeQL Database description: A CodeQL database. type: object @@ -61760,9 +62422,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61789,8 +62451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61802,7 +62464,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *438 examples: default: value: @@ -61834,11 +62496,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &477 + '302': &472 description: Found - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61858,8 +62520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *330 - - *331 + - *325 + - *326 - name: language in: path description: The language of the CodeQL database. @@ -61869,9 +62531,9 @@ paths: responses: '204': description: Response - '403': *436 + '403': *431 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61897,8 +62559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -61907,7 +62569,7 @@ paths: type: object additionalProperties: false properties: - language: &444 + language: &439 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +62648,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &448 + schema: &443 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61996,7 +62658,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *444 + query_language: *439 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +62705,7 @@ paths: items: type: object properties: - repository: &445 + repository: &440 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +62741,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &449 + analysis_status: &444 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +62773,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &446 + access_mismatch_repos: &441 type: object properties: repository_count: @@ -62125,7 +62787,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *445 + items: *440 required: - repository_count - repositories @@ -62147,8 +62809,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *446 - over_limit_repos: *446 + no_codeql_db_repos: *441 + over_limit_repos: *441 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +62826,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &447 + value: &442 summary: Default response value: id: 1 @@ -62316,17 +62978,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *447 + value: *442 repository_lists: summary: Response for a successful variant analysis submission - value: *447 + value: *442 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62347,8 +63009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *330 - - *331 + - *325 + - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,11 +63022,11 @@ paths: description: Response content: application/json: - schema: *448 + schema: *443 examples: - default: *447 + default: *442 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62385,7 +63047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *330 + - *325 - name: repo in: path description: The name of the controller repository. @@ -62420,7 +63082,7 @@ paths: type: object properties: repository: *53 - analysis_status: *449 + analysis_status: *444 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62524,7 +63186,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62545,8 +63207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -62631,9 +63293,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *430 + '403': *425 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62652,8 +63314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -62720,7 +63382,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -62745,7 +63407,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *436 + '403': *431 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62759,7 +63421,7 @@ paths: content: application/json: schema: *3 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62816,8 +63478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -62825,7 +63487,7 @@ paths: schema: type: object properties: - commit_sha: *450 + commit_sha: *445 ref: type: string description: |- @@ -62883,7 +63545,7 @@ paths: schema: type: object properties: - id: *441 + id: *436 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,11 +63559,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *436 + '403': *431 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62920,8 +63582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *330 - - *331 + - *325 + - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,10 +63629,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *430 + '403': *425 '404': description: Not Found if the sarif id does not match any upload - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62992,8 +63654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63049,7 +63711,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *163 + '204': *172 '304': *37 '403': *29 '404': *6 @@ -63074,8 +63736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +63857,8 @@ paths: parameters: - *17 - *19 - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63212,7 +63874,7 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: default: value: @@ -63488,7 +64150,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -63510,8 +64172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -63574,22 +64236,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63613,8 +64275,8 @@ paths: parameters: - *17 - *19 - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -63654,7 +64316,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *106 + '500': *105 '400': *14 '401': *25 '403': *29 @@ -63678,8 +64340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +64376,14 @@ paths: type: integer machines: type: array - items: &661 + items: &666 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *452 - required: *453 + properties: *447 + required: *448 examples: - default: &662 + default: &667 value: total_count: 2 machines: @@ -63738,7 +64400,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -63761,8 +64423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +64508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63892,7 +64554,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63913,8 +64575,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -63932,7 +64594,7 @@ paths: type: integer secrets: type: array - items: &457 + items: &452 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,9 +64614,9 @@ paths: - created_at - updated_at examples: - default: *454 + default: *449 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63975,16 +64637,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *455 + schema: *450 examples: - default: *456 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +64666,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *457 + schema: *452 examples: - default: *458 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,9 +64696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -64064,7 +64726,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -64088,9 +64750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -64118,8 +64780,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *330 - - *331 + - *325 + - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +64823,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &459 + properties: &454 login: type: string example: octocat @@ -64254,7 +64916,7 @@ paths: user_view_type: type: string example: public - required: &460 + required: &455 - avatar_url - events_url - followers_url @@ -64303,7 +64965,7 @@ paths: admin: false role_name: write headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -64328,9 +64990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '204': description: Response if user is a collaborator @@ -64376,9 +65038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 requestBody: required: false content: @@ -64404,7 +65066,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &526 + schema: &521 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64415,7 +65077,7 @@ paths: example: 42 type: integer format: int64 - repository: *137 + repository: *142 invitee: title: Simple User description: A GitHub user. @@ -64633,9 +65295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '204': description: No Content when collaborator was removed from the repository. @@ -64666,9 +65328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *330 - - *331 - - *63 + - *325 + - *326 + - *59 responses: '200': description: if user has admin permissions @@ -64688,8 +65350,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *459 - required: *460 + properties: *454 + required: *455 nullable: true required: - permission @@ -64744,8 +65406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -64755,7 +65417,7 @@ paths: application/json: schema: type: array - items: &461 + items: &456 title: Commit Comment description: Commit Comment type: object @@ -64796,8 +65458,8 @@ paths: updated_at: type: string format: date-time - author_association: *72 - reactions: *73 + author_association: *71 + reactions: *72 required: - url - html_url @@ -64813,7 +65475,7 @@ paths: - created_at - updated_at examples: - default: &464 + default: &459 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64847,7 +65509,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64872,17 +65534,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *461 + schema: *456 examples: - default: &465 + default: &460 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,9 +65601,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -64963,7 +65625,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -65014,9 +65676,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -65037,9 +65699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -65065,11 +65727,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -65088,9 +65750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -65122,16 +65784,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -65153,10 +65815,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -65205,8 +65867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *330 - - *331 + - *325 + - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +65924,9 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: &575 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65334,8 +65996,8 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *58 - '500': *106 + Link: *54 + '500': *105 '400': *14 '404': *6 '409': *47 @@ -65358,9 +66020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *330 - - *331 - - &463 + - *325 + - *326 + - &458 name: commit_sha description: The SHA of the commit. in: path @@ -65432,9 +66094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -65444,11 +66106,11 @@ paths: application/json: schema: type: array - items: *461 + items: *456 examples: - default: *464 + default: *459 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65474,9 +66136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 requestBody: required: true content: @@ -65511,9 +66173,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: - default: *465 + default: *460 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +66203,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 - *17 - *19 responses: @@ -65553,9 +66215,9 @@ paths: application/json: schema: type: array - items: *466 + items: *461 examples: - default: &567 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66034,7 +66696,7 @@ paths: auto_merge: draft: false headers: - Link: *58 + Link: *54 '409': *47 x-github: githubCloudOnly: false @@ -66092,11 +66754,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 - - &467 + - &462 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +66773,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *457 examples: - default: &554 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66199,8 +66861,8 @@ paths: ..... '422': *15 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 '409': *47 x-github: githubCloudOnly: false @@ -66226,11 +66888,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *330 - - *331 - - *467 - - *468 - - *469 + - *325 + - *326 + - *462 + - *463 + - *464 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,11 +66926,11 @@ paths: type: integer check_runs: type: array - items: *411 + items: *406 examples: - default: *470 + default: *465 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66291,9 +66953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +66963,7 @@ paths: schema: type: integer example: 1 - - *468 + - *463 - *17 - *19 responses: @@ -66319,7 +66981,7 @@ paths: type: integer check_suites: type: array - items: *416 + items: *411 examples: default: value: @@ -66494,7 +67156,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66519,9 +67181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - *17 - *19 responses: @@ -66588,7 +67250,7 @@ paths: type: string total_count: type: integer - repository: *137 + repository: *142 commit_url: type: string format: uri @@ -66719,9 +67381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *330 - - *331 - - *467 + - *325 + - *326 + - *462 - *17 - *19 responses: @@ -66731,7 +67393,7 @@ paths: application/json: schema: type: array - items: &632 + items: &637 title: Status description: The status of a commit. type: object @@ -66811,8 +67473,8 @@ paths: type: User site_admin: false headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +67502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -66870,20 +67532,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *471 - required: *472 + properties: *466 + required: *467 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &473 + properties: &468 url: type: string format: uri html_url: type: string format: uri - required: &474 + required: &469 - url - html_url nullable: true @@ -66891,32 +67553,32 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true contributing: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true readme: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true issue_template: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true pull_request_template: title: Community Health File type: object - properties: *473 - required: *474 + properties: *468 + required: *469 nullable: true required: - code_of_conduct @@ -67043,8 +67705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 - name: basehead @@ -67087,8 +67749,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *462 - merge_base_commit: *462 + base_commit: *457 + merge_base_commit: *457 status: type: string enum: @@ -67108,10 +67770,10 @@ paths: example: 6 commits: type: array - items: *462 + items: *457 files: type: array - items: *475 + items: *470 required: - url - html_url @@ -67354,8 +68016,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67397,8 +68059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -67541,7 +68203,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &476 + response-if-content-is-a-file: &471 summary: Response if content is a file value: type: file @@ -67673,7 +68335,7 @@ paths: - size - type - url - - &580 + - &577 title: Content File description: Content File type: object @@ -67874,7 +68536,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *476 + response-if-content-is-a-file: *471 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +68605,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *477 + '302': *472 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +68628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -68060,7 +68722,7 @@ paths: description: Response content: application/json: - schema: &478 + schema: &473 title: File Commit description: File Commit type: object @@ -68212,7 +68874,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: example-for-creating-a-file: value: @@ -68266,7 +68928,7 @@ paths: schema: oneOf: - *3 - - &508 + - &503 description: Repository rule violation was detected type: object properties: @@ -68287,7 +68949,7 @@ paths: items: type: object properties: - placeholder_id: &624 + placeholder_id: &629 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +68981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *330 - - *331 + - *325 + - *326 - name: path description: path parameter in: path @@ -68381,7 +69043,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: default: value: @@ -68416,7 +69078,7 @@ paths: '422': *15 '404': *6 '409': *47 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68436,8 +69098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *330 - - *331 + - *325 + - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68537,7 +69199,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *58 + Link: *54 '204': description: Response if repository is empty '403': *29 @@ -68560,31 +69222,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *330 - - *331 - - *170 - - *171 - - *172 - - *173 + - *325 + - *326 + - *179 + - *180 + - *181 + - *182 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *174 - - *479 - - *175 - - *176 + - *183 + - *474 + - *184 + - *185 - *48 - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -68595,8 +69249,6 @@ paths: default: 30 - *40 - *41 - - *177 - - *178 responses: '200': description: Response @@ -68604,11 +69256,11 @@ paths: application/json: schema: type: array - items: &482 + items: &477 type: object description: A Dependabot alert. properties: - number: *54 + number: *158 state: type: string description: The state of the Dependabot alert. @@ -68650,13 +69302,13 @@ paths: - unknown - direct - transitive - security_advisory: *480 + security_advisory: *475 security_vulnerability: *52 - url: *56 - html_url: *57 - created_at: *55 - updated_at: *153 - dismissed_at: *155 + url: *161 + html_url: *162 + created_at: *159 + updated_at: *160 + dismissed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -68680,8 +69332,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *154 - auto_dismissed_at: *481 + fixed_at: *163 + auto_dismissed_at: *476 required: - number - state @@ -68911,9 +69563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *330 - - *331 - - &483 + - *325 + - *326 + - &478 name: alert_number in: path description: |- @@ -68922,13 +69574,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *54 + schema: *158 responses: '200': description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69041,9 +69693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *330 - - *331 - - *483 + - *325 + - *326 + - *478 requestBody: required: true content: @@ -69088,7 +69740,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *477 examples: default: value: @@ -69217,8 +69869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -69236,7 +69888,7 @@ paths: type: integer secrets: type: array - items: &486 + items: &481 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69267,7 +69919,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69289,16 +69941,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *484 + schema: *479 examples: - default: *485 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69318,15 +69970,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '200': description: Response content: application/json: - schema: *486 + schema: *481 examples: default: value: @@ -69352,9 +70004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 requestBody: required: true content: @@ -69382,7 +70034,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -69406,9 +70058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *330 - - *331 - - *145 + - *325 + - *326 + - *150 responses: '204': description: Response @@ -69430,8 +70082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *330 - - *331 + - *325 + - *326 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -69567,7 +70219,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *58 + Link: *54 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -69591,8 +70243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -69808,7 +70460,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *58 + Link: *54 '404': *6 '403': *29 x-github: @@ -69831,8 +70483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -69907,7 +70559,7 @@ paths: - version - url additionalProperties: false - metadata: &487 + metadata: &482 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69940,7 +70592,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *487 + metadata: *482 resolved: type: object description: A collection of resolved package dependencies. @@ -69953,7 +70605,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *487 + metadata: *482 relationship: type: string description: A notation of whether a dependency is requested @@ -70082,8 +70734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *330 - - *331 + - *325 + - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -70123,11 +70775,11 @@ paths: application/json: schema: type: array - items: *488 + items: *483 examples: - default: *489 + default: *484 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70191,8 +70843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -70273,7 +70925,7 @@ paths: description: Response content: application/json: - schema: *488 + schema: *483 examples: simple-example: summary: Simple example @@ -70346,9 +70998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *330 - - *331 - - &490 + - *325 + - *326 + - &485 name: deployment_id description: deployment_id parameter in: path @@ -70360,7 +71012,7 @@ paths: description: Response content: application/json: - schema: *488 + schema: *483 examples: default: value: @@ -70425,9 +71077,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 responses: '204': description: Response @@ -70449,9 +71101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 - *17 - *19 responses: @@ -70461,7 +71113,7 @@ paths: application/json: schema: type: array - items: &491 + items: &486 title: Deployment Status description: The status of a deployment. type: object @@ -70552,8 +71204,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -70602,7 +71254,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -70622,9 +71274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 requestBody: required: true content: @@ -70699,9 +71351,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *486 examples: - default: &492 + default: &487 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70757,9 +71409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *330 - - *331 - - *490 + - *325 + - *326 + - *485 - name: status_id in: path required: true @@ -70770,9 +71422,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *486 examples: - default: *492 + default: *487 '404': *6 x-github: githubCloudOnly: false @@ -70797,8 +71449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -70855,8 +71507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -70873,7 +71525,7 @@ paths: type: integer environments: type: array - items: &494 + items: &489 title: Environment description: Details of a deployment environment type: object @@ -70925,7 +71577,7 @@ paths: type: type: string example: wait_timer - wait_timer: &496 + wait_timer: &491 type: integer example: 30 description: The amount of time to delay a job after @@ -70962,11 +71614,11 @@ paths: items: type: object properties: - type: *493 + type: *488 reviewer: anyOf: - *4 - - *169 + - *178 required: - id - node_id @@ -70986,7 +71638,7 @@ paths: - id - node_id - type - deployment_branch_policy: &497 + deployment_branch_policy: &492 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71102,9 +71754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *330 - - *331 - - &495 + - *325 + - *326 + - &490 name: environment_name in: path required: true @@ -71117,9 +71769,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *489 examples: - default: &498 + default: &493 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71203,9 +71855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: false content: @@ -71214,7 +71866,7 @@ paths: type: object nullable: true properties: - wait_timer: *496 + wait_timer: *491 prevent_self_review: type: boolean example: false @@ -71231,13 +71883,13 @@ paths: items: type: object properties: - type: *493 + type: *488 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *497 + deployment_branch_policy: *492 additionalProperties: false examples: default: @@ -71257,9 +71909,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *489 examples: - default: *498 + default: *493 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71283,9 +71935,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 responses: '204': description: Default response @@ -71310,9 +71962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 - *17 - *19 responses: @@ -71330,7 +71982,7 @@ paths: example: 2 branch_policies: type: array - items: &499 + items: &494 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71387,9 +72039,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: true content: @@ -71435,9 +72087,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - example-wildcard: &500 + example-wildcard: &495 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71479,10 +72131,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - &501 + - *325 + - *326 + - *490 + - &496 name: branch_policy_id in: path required: true @@ -71494,9 +72146,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71515,10 +72167,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - *501 + - *325 + - *326 + - *490 + - *496 requestBody: required: true content: @@ -71546,9 +72198,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *494 examples: - default: *500 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71567,10 +72219,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *330 - - *331 - - *495 - - *501 + - *325 + - *326 + - *490 + - *496 responses: '204': description: Response @@ -71595,9 +72247,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 responses: '200': description: List of deployment protection rules @@ -71613,7 +72265,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &502 + items: &497 title: Deployment protection rule description: Deployment protection rule type: object @@ -71632,7 +72284,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &503 + app: &498 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71731,9 +72383,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 requestBody: content: application/json: @@ -71754,9 +72406,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *502 + schema: *497 examples: - default: &504 + default: &499 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71791,9 +72443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *495 - - *331 - - *330 + - *490 + - *326 + - *325 - *19 - *17 responses: @@ -71812,7 +72464,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *503 + items: *498 examples: default: value: @@ -71847,10 +72499,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *330 - - *331 - - *495 - - &505 + - *325 + - *326 + - *490 + - &500 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71862,9 +72514,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *497 examples: - default: *504 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71885,10 +72537,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *495 - - *331 - - *330 - - *505 + - *490 + - *326 + - *325 + - *500 responses: '204': description: Response @@ -71914,9 +72566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 - *17 - *19 responses: @@ -71934,11 +72586,11 @@ paths: type: integer secrets: type: array - items: *378 + items: *373 examples: - default: *379 + default: *374 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71961,17 +72613,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 responses: '200': description: Response content: application/json: - schema: *380 + schema: *375 examples: - default: *381 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71993,18 +72645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 responses: '200': description: Response content: application/json: - schema: *378 + schema: *373 examples: - default: *506 + default: *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72026,10 +72678,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 requestBody: required: true content: @@ -72060,7 +72712,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -72086,10 +72738,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *330 - - *331 - - *495 - - *145 + - *325 + - *326 + - *490 + - *150 responses: '204': description: Default response @@ -72114,10 +72766,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *330 - - *331 - - *495 - - *349 + - *325 + - *326 + - *490 + - *344 - *19 responses: '200': @@ -72134,11 +72786,11 @@ paths: type: integer variables: type: array - items: *382 + items: *377 examples: - default: *383 + default: *378 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72159,9 +72811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *330 - - *331 - - *495 + - *325 + - *326 + - *490 requestBody: required: true content: @@ -72188,7 +72840,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -72213,18 +72865,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *330 - - *331 - - *495 - - *148 + - *325 + - *326 + - *490 + - *153 responses: '200': description: Response content: application/json: - schema: *382 + schema: *377 examples: - default: *507 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72245,10 +72897,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *330 - - *331 - - *148 - - *495 + - *325 + - *326 + - *153 + - *490 requestBody: required: true content: @@ -72290,10 +72942,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *330 - - *331 - - *148 - - *495 + - *325 + - *326 + - *153 + - *490 responses: '204': description: Response @@ -72315,8 +72967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -72326,7 +72978,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: 200-response: value: @@ -72384,8 +73036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *330 - - *331 + - *325 + - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72407,7 +73059,7 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: default: value: @@ -72520,7 +73172,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *58 + Link: *54 '400': *14 x-github: githubCloudOnly: false @@ -72544,8 +73196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -72577,9 +73229,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 '400': *14 '422': *15 '403': *29 @@ -72600,8 +73252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -72661,7 +73313,7 @@ paths: schema: oneOf: - *111 - - *508 + - *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72686,8 +73338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *330 - - *331 + - *325 + - *326 - name: file_sha in: path required: true @@ -72786,8 +73438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -72896,7 +73548,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &504 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73110,15 +73762,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *330 - - *331 - - *463 + - *325 + - *326 + - *458 responses: '200': description: Response content: application/json: - schema: *509 + schema: *504 examples: default: value: @@ -73174,9 +73826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *330 - - *331 - - &510 + - *325 + - *326 + - &505 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -73193,7 +73845,7 @@ paths: application/json: schema: type: array - items: &511 + items: &506 title: Git Reference description: Git references within a repository type: object @@ -73246,7 +73898,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *58 + Link: *54 '409': *47 x-github: githubCloudOnly: false @@ -73268,17 +73920,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 responses: '200': description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: &512 + default: &507 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73307,8 +73959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73337,9 +73989,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: *512 + default: *507 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73365,9 +74017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 requestBody: required: true content: @@ -73396,9 +74048,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *506 examples: - default: *512 + default: *507 '422': *15 '409': *47 x-github: @@ -73416,9 +74068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *330 - - *331 - - *510 + - *325 + - *326 + - *505 responses: '204': description: Response @@ -73473,8 +74125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73541,7 +74193,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &509 title: Git Tag description: Metadata for a Git tag type: object @@ -73592,7 +74244,7 @@ paths: - sha - type - url - verification: *513 + verification: *508 required: - sha - url @@ -73602,7 +74254,7 @@ paths: - tag - message examples: - default: &515 + default: &510 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73675,8 +74327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *330 - - *331 + - *325 + - *326 - name: tag_sha in: path required: true @@ -73687,9 +74339,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *509 examples: - default: *515 + default: *510 '404': *6 '409': *47 x-github: @@ -73713,8 +74365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -73787,7 +74439,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &511 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73883,8 +74535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *330 - - *331 + - *325 + - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73907,7 +74559,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *511 examples: default-response: summary: Default response @@ -73966,8 +74618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -73977,7 +74629,7 @@ paths: application/json: schema: type: array - items: &517 + items: &512 title: Webhook description: Webhooks for repositories. type: object @@ -74031,7 +74683,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &747 + last_response: &751 title: Hook Response type: object properties: @@ -74086,7 +74738,7 @@ paths: status: unused message: headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -74105,8 +74757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -74158,9 +74810,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: &518 + default: &513 value: type: Repository id: 12345678 @@ -74208,17 +74860,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '200': description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: *518 + default: *513 '404': *6 x-github: githubCloudOnly: false @@ -74238,9 +74890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 requestBody: required: true content: @@ -74285,9 +74937,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *512 examples: - default: *518 + default: *513 '422': *15 '404': *6 x-github: @@ -74308,9 +74960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74334,9 +74986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '200': description: Response @@ -74363,9 +75015,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 requestBody: required: false content: @@ -74409,11 +75061,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *17 - - *187 + - *194 responses: '200': description: Response @@ -74421,9 +75073,9 @@ paths: application/json: schema: type: array - items: *188 + items: *195 examples: - default: *189 + default: *196 '400': *14 '422': *15 x-github: @@ -74442,18 +75094,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *197 examples: - default: *191 + default: *198 '400': *14 '422': *15 x-github: @@ -74472,9 +75124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 - *16 responses: '202': *39 @@ -74497,9 +75149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74524,9 +75176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *330 - - *331 - - *186 + - *325 + - *326 + - *193 responses: '204': description: Response @@ -74549,8 +75201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response if immutable releases are enabled @@ -74596,10 +75248,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '409': *47 x-github: githubCloudOnly: false @@ -74617,10 +75269,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '409': *47 x-github: githubCloudOnly: false @@ -74675,14 +75327,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &519 + schema: &514 title: Import description: A repository import from an external source. type: object @@ -74781,7 +75433,7 @@ paths: - html_url - authors_url examples: - default: &522 + default: &517 value: vcs: subversion use_lfs: true @@ -74797,7 +75449,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &520 + '503': &515 description: Unavailable due to service under maintenance. content: application/json: @@ -74826,8 +75478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -74875,7 +75527,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: default: value: @@ -74900,7 +75552,7 @@ paths: type: string '422': *15 '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74928,8 +75580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -74978,7 +75630,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: example-1: summary: Example 1 @@ -75026,7 +75678,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75049,12 +75701,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75080,9 +75732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *330 - - *331 - - &684 + - *325 + - *326 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75096,7 +75748,7 @@ paths: application/json: schema: type: array - items: &521 + items: &516 title: Porter Author description: Porter Author type: object @@ -75150,7 +75802,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75175,8 +75827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *330 - - *331 + - *325 + - *326 - name: author_id in: path required: true @@ -75206,7 +75858,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *516 examples: default: value: @@ -75219,7 +75871,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75243,8 +75895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75285,7 +75937,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75313,8 +75965,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -75341,11 +75993,11 @@ paths: description: Response content: application/json: - schema: *519 + schema: *514 examples: - default: *522 + default: *517 '422': *15 - '503': *520 + '503': *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75368,8 +76020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75377,8 +76029,8 @@ paths: application/json: schema: *22 examples: - default: *523 - '301': *339 + default: *518 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -75398,8 +76050,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -75407,12 +76059,12 @@ paths: application/json: schema: anyOf: - - *204 + - *211 - type: object properties: {} additionalProperties: false examples: - default: &525 + default: &520 value: limit: collaborators_only origin: repository @@ -75437,13 +76089,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: application/json: - schema: *524 + schema: *519 examples: default: summary: Example request body @@ -75455,9 +76107,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: - default: *525 + default: *520 '409': description: Response x-github: @@ -75479,8 +76131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -75503,8 +76155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -75514,9 +76166,9 @@ paths: application/json: schema: type: array - items: *526 + items: *521 examples: - default: &677 + default: &681 value: - id: 1 repository: @@ -75630,7 +76282,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75647,9 +76299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *330 - - *331 - - *208 + - *325 + - *326 + - *215 requestBody: required: false content: @@ -75678,7 +76330,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *521 examples: default: value: @@ -75809,9 +76461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *330 - - *331 - - *208 + - *325 + - *326 + - *215 responses: '204': description: Response @@ -75842,8 +76494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *330 - - *331 + - *325 + - *326 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -75891,7 +76543,7 @@ paths: required: false schema: type: string - - *212 + - *219 - name: sort description: What to sort results by. in: query @@ -75904,7 +76556,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -75914,9 +76566,9 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: &535 + default: &530 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76063,8 +76715,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '422': *15 '404': *6 x-github: @@ -76093,8 +76745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -76176,9 +76828,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: &532 + default: &527 value: id: 1 node_id: MDU6SXNzdWUx @@ -76332,9 +76984,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *77 + '503': *106 '404': *6 - '410': *336 + '410': *331 x-github: triggersNotification: true githubCloudOnly: false @@ -76362,9 +77014,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *330 - - *331 - - *96 + - *325 + - *326 + - *94 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -76374,7 +77026,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -76384,9 +77036,9 @@ paths: application/json: schema: type: array - items: *527 + items: *522 examples: - default: &534 + default: &529 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76417,7 +77069,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 '422': *15 '404': *6 x-github: @@ -76444,17 +77096,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: &528 + default: &523 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76508,9 +77160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -76532,9 +77184,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -76552,9 +77204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -76574,9 +77226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -76602,11 +77254,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -76625,9 +77277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -76659,16 +77311,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -76690,10 +77342,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -76713,8 +77365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -76724,7 +77376,7 @@ paths: application/json: schema: type: array - items: &531 + items: &526 title: Issue Event description: Issue Event type: object @@ -76767,8 +77419,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *529 - required: *530 + properties: *524 + required: *525 nullable: true label: title: Issue Event Label @@ -76812,7 +77464,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *169 + requested_team: *178 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76877,7 +77529,7 @@ paths: required: - from - to - author_association: *72 + author_association: *71 lock_reason: type: string nullable: true @@ -76890,8 +77542,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 required: - id - node_id @@ -77057,7 +77709,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -77075,8 +77727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *330 - - *331 + - *325 + - *326 - name: event_id in: path required: true @@ -77087,7 +77739,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *526 examples: default: value: @@ -77280,7 +77932,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *336 + '410': *331 '403': *29 x-github: githubCloudOnly: false @@ -77314,9 +77966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *330 - - *331 - - &533 + - *325 + - *326 + - &528 name: issue_number description: The number that identifies the issue. in: path @@ -77328,12 +77980,12 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '404': *6 - '410': *336 + '410': *331 '304': *37 x-github: githubCloudOnly: false @@ -77358,9 +78010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -77464,15 +78116,15 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 '422': *15 - '503': *77 + '503': *106 '403': *29 - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77490,9 +78142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -77518,9 +78170,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77536,9 +78188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: content: application/json: @@ -77563,9 +78215,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77587,9 +78239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: assignee in: path required: true @@ -77629,10 +78281,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *330 - - *331 - - *533 - - *79 + - *325 + - *326 + - *528 + - *77 - *17 - *19 responses: @@ -77642,13 +78294,13 @@ paths: application/json: schema: type: array - items: *527 + items: *522 examples: - default: *534 + default: *529 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77677,9 +78329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -77701,16 +78353,16 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -77738,9 +78390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77750,14 +78402,14 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77785,9 +78437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -77809,17 +78461,17 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *339 + '301': *334 '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -77850,9 +78502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77864,15 +78516,15 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 x-github: triggersNotification: true githubCloudOnly: false @@ -77898,9 +78550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77910,14 +78562,14 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77934,9 +78586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -77950,7 +78602,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &537 + - &532 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77981,8 +78633,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 label: type: object properties: @@ -78004,7 +78656,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &533 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78035,8 +78687,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 label: type: object properties: @@ -78124,8 +78776,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 assigner: *4 required: @@ -78140,7 +78792,7 @@ paths: - performed_via_github_app - assignee - assigner - - &539 + - &534 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78171,8 +78823,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 milestone: type: object properties: @@ -78191,7 +78843,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &535 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78222,8 +78874,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 milestone: type: object properties: @@ -78242,7 +78894,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &536 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78273,8 +78925,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 rename: type: object properties: @@ -78296,7 +78948,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &537 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78327,10 +78979,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 review_requester: *4 - requested_team: *169 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -78343,7 +78995,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &538 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78374,10 +79026,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 review_requester: *4 - requested_team: *169 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -78390,7 +79042,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &539 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78421,8 +79073,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 dismissed_review: type: object properties: @@ -78450,7 +79102,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &540 title: Locked Issue Event description: Locked Issue Event type: object @@ -78481,8 +79133,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 lock_reason: type: string example: '"off-topic"' @@ -78498,7 +79150,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &541 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78529,8 +79181,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78564,7 +79216,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &542 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78595,8 +79247,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78630,7 +79282,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &548 + - &543 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78661,8 +79313,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 project_card: type: object properties: @@ -78696,7 +79348,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &549 + - &544 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78786,8 +79438,8 @@ paths: name: label color: red headers: - Link: *58 - '410': *336 + Link: *54 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78804,9 +79456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -78816,9 +79468,9 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: &536 + default: &531 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78835,10 +79487,10 @@ paths: color: a2eeef default: false headers: - Link: *58 - '301': *339 + Link: *54 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78855,9 +79507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -78916,12 +79568,12 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 - '301': *339 + default: *531 + '301': *334 '404': *6 - '410': *336 + '410': *331 '422': *15 x-github: githubCloudOnly: false @@ -78938,9 +79590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -79000,12 +79652,12 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 - '301': *339 + default: *531 + '301': *334 '404': *6 - '410': *336 + '410': *331 '422': *15 x-github: githubCloudOnly: false @@ -79022,15 +79674,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '204': description: Response - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79049,9 +79701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: name in: path required: true @@ -79064,7 +79716,7 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: default: value: @@ -79075,9 +79727,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *339 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79097,9 +79749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: false content: @@ -79127,7 +79779,7 @@ paths: '204': description: Response '403': *29 - '410': *336 + '410': *331 '404': *6 '422': *15 x-github: @@ -79145,9 +79797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '204': description: Response @@ -79177,20 +79829,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 responses: '200': description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 - '301': *339 + default: *527 + '301': *334 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79207,9 +79859,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -79235,13 +79887,13 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79259,9 +79911,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79293,16 +79945,16 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -79324,10 +79976,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *330 - - *331 - - *533 + - *325 - *326 + - *528 + - *321 responses: '204': description: Response @@ -79356,9 +80008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79380,9 +80032,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79415,9 +80067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -79427,13 +80079,13 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *535 + default: *530 headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79461,9 +80113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79490,16 +80142,16 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *336 + '410': *331 '422': *15 '404': *6 x-github: @@ -79519,9 +80171,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 requestBody: required: true content: @@ -79552,13 +80204,13 @@ paths: description: Response content: application/json: - schema: *71 + schema: *70 examples: - default: *532 + default: *527 '403': *29 '404': *6 '422': *7 - '503': *77 + '503': *106 x-github: triggersNotification: true githubCloudOnly: false @@ -79576,9 +80228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *330 - - *331 - - *533 + - *325 + - *326 + - *528 - *17 - *19 responses: @@ -79593,6 +80245,11 @@ paths: description: Timeline Event type: object anyOf: + - *532 + - *533 + - *534 + - *535 + - *536 - *537 - *538 - *539 @@ -79601,11 +80258,6 @@ paths: - *542 - *543 - *544 - - *545 - - *546 - - *547 - - *548 - - *549 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79648,7 +80300,7 @@ paths: issue_url: type: string format: uri - author_association: *72 + author_association: *71 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -79658,9 +80310,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - event - actor @@ -79691,7 +80343,7 @@ paths: properties: type: type: string - issue: *71 + issue: *70 required: - event - created_at @@ -79891,7 +80543,7 @@ paths: type: string body_text: type: string - author_association: *72 + author_association: *71 required: - event - id @@ -79914,7 +80566,7 @@ paths: type: string comments: type: array - items: &569 + items: &566 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80003,7 +80655,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *72 + author_association: *71 _links: type: object properties: @@ -80087,7 +80739,7 @@ paths: enum: - line - file - reactions: *73 + reactions: *72 body_html: type: string example: '"

comment body

"' @@ -80123,7 +80775,7 @@ paths: type: string comments: type: array - items: *461 + items: *456 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80154,8 +80806,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 required: - id @@ -80198,8 +80850,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 assignee: *4 required: - id @@ -80242,8 +80894,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 state_reason: type: string nullable: true @@ -80410,9 +81062,9 @@ paths: type: User site_admin: true headers: - Link: *58 + Link: *54 '404': *6 - '410': *336 + '410': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80429,8 +81081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -80440,7 +81092,7 @@ paths: application/json: schema: type: array - items: &550 + items: &545 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80490,7 +81142,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80506,8 +81158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -80543,9 +81195,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *545 examples: - default: &551 + default: &546 value: id: 1 key: ssh-rsa AAA... @@ -80579,9 +81231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *330 - - *331 - - &552 + - *325 + - *326 + - &547 name: key_id description: The unique identifier of the key. in: path @@ -80593,9 +81245,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *545 examples: - default: *551 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80613,9 +81265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *330 - - *331 - - *552 + - *325 + - *326 + - *547 responses: '204': description: Response @@ -80635,8 +81287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -80646,11 +81298,11 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 + default: *531 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -80669,8 +81321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -80706,9 +81358,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: - default: &553 + default: &548 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80740,8 +81392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80752,9 +81404,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: - default: *553 + default: *548 '404': *6 x-github: githubCloudOnly: false @@ -80771,8 +81423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80811,7 +81463,7 @@ paths: description: Response content: application/json: - schema: *70 + schema: *69 examples: default: value: @@ -80837,8 +81489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *330 - - *331 + - *325 + - *326 - name: name in: path required: true @@ -80864,8 +81516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -80904,9 +81556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *330 - - *331 - - *437 + - *325 + - *326 + - *432 responses: '200': description: Response @@ -80968,8 +81620,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true required: - _links @@ -81051,8 +81703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81117,8 +81769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81152,9 +81804,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *462 + schema: *457 examples: - default: *554 + default: *549 '204': description: Response when already merged '404': @@ -81179,8 +81831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81221,12 +81873,12 @@ paths: application/json: schema: type: array - items: &555 + items: &550 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 examples: default: value: @@ -81265,7 +81917,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -81282,8 +81934,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81323,9 +81975,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: &556 + default: &551 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81384,9 +82036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *330 - - *331 - - &557 + - *325 + - *326 + - &552 name: milestone_number description: The number that identifies the milestone. in: path @@ -81398,9 +82050,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: *556 + default: *551 '404': *6 x-github: githubCloudOnly: false @@ -81417,9 +82069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 requestBody: required: false content: @@ -81457,9 +82109,9 @@ paths: description: Response content: application/json: - schema: *555 + schema: *550 examples: - default: *556 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81475,9 +82127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 responses: '204': description: Response @@ -81498,9 +82150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *330 - - *331 - - *557 + - *325 + - *326 + - *552 - *17 - *19 responses: @@ -81510,11 +82162,11 @@ paths: application/json: schema: type: array - items: *70 + items: *69 examples: - default: *536 + default: *531 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81531,12 +82183,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *330 - - *331 - - *558 - - *559 - - *79 - - *560 + - *325 + - *326 + - *553 + - *554 + - *77 + - *555 - *17 - *19 responses: @@ -81546,11 +82198,11 @@ paths: application/json: schema: type: array - items: *99 + items: *97 examples: - default: *561 + default: *556 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81572,8 +82224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -81631,14 +82283,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: &562 + schema: &557 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81763,7 +82415,7 @@ paths: - custom_404 - public examples: - default: &563 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81804,8 +82456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81859,9 +82511,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *557 examples: - default: *563 + default: *558 '422': *15 '409': *47 x-github: @@ -81884,8 +82536,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -81984,8 +82636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -82011,8 +82663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -82022,7 +82674,7 @@ paths: application/json: schema: type: array - items: &564 + items: &559 title: Page Build description: Page Build type: object @@ -82097,7 +82749,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82116,8 +82768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *330 - - *331 + - *325 + - *326 responses: '201': description: Response @@ -82162,16 +82814,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *564 + schema: *559 examples: - default: &565 + default: &560 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82219,8 +82871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *330 - - *331 + - *325 + - *326 - name: build_id in: path required: true @@ -82231,9 +82883,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *559 examples: - default: *565 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82253,8 +82905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82359,9 +83011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *330 - - *331 - - &566 + - *325 + - *326 + - &561 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82419,11 +83071,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *330 - - *331 - - *566 + - *325 + - *326 + - *561 responses: - '204': *163 + '204': *172 '404': *6 x-github: githubCloudOnly: false @@ -82448,8 +83100,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -82680,7 +83332,7 @@ paths: description: Empty response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -82707,8 +83359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Private vulnerability reporting status @@ -82745,10 +83397,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '422': *14 x-github: githubCloudOnly: false @@ -82767,10 +83419,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: - '204': *163 + '204': *172 '422': *14 x-github: githubCloudOnly: false @@ -82791,8 +83443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: Indicates the state of the projects to return. in: query @@ -82813,7 +83465,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -82849,11 +83501,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *58 + Link: *54 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -82876,8 +83528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82903,13 +83555,13 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *335 + default: *330 '401': *25 '403': *29 '404': *6 - '410': *336 + '410': *331 '422': *7 x-github: githubCloudOnly: false @@ -82932,8 +83584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -82941,16 +83593,9 @@ paths: application/json: schema: type: array - items: *262 + items: *104 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *562 '403': *29 '404': *6 x-github: @@ -82972,8 +83617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -82985,19 +83630,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *262 + items: *104 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *563 responses: '204': description: No Content when custom property values are successfully created @@ -83035,8 +83672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *330 - - *331 + - *325 + - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -83096,11 +83733,11 @@ paths: application/json: schema: type: array - items: *466 + items: *461 examples: - default: *567 + default: *564 headers: - Link: *58 + Link: *54 '304': *37 '422': *15 x-github: @@ -83130,8 +83767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -83196,7 +83833,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &568 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83307,8 +83944,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true active_lock_reason: type: string @@ -83353,7 +83990,7 @@ paths: nullable: true requested_teams: type: array - items: *308 + items: *303 nullable: true head: type: object @@ -83362,7 +83999,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: *4 @@ -83379,7 +84016,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *66 sha: type: string user: *4 @@ -83392,14 +84029,14 @@ paths: _links: type: object properties: - comments: *252 - commits: *252 - statuses: *252 - html: *252 - issue: *252 - review_comments: *252 - review_comment: *252 - self: *252 + comments: *258 + commits: *258 + statuses: *258 + html: *258 + issue: *258 + review_comments: *258 + review_comment: *258 + self: *258 required: - comments - commits @@ -83409,8 +84046,8 @@ paths: - review_comments - review_comment - self - author_association: *72 - auto_merge: *568 + author_association: *71 + auto_merge: *565 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83502,7 +84139,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &569 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -84029,8 +84666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: sort in: query required: false @@ -84049,7 +84686,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -84059,9 +84696,9 @@ paths: application/json: schema: type: array - items: *569 + items: *566 examples: - default: &574 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84113,7 +84750,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84138,17 +84775,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '200': description: Response content: application/json: - schema: *569 + schema: *566 examples: - default: &570 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84223,9 +84860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -84247,9 +84884,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: - default: *570 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84265,9 +84902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 responses: '204': description: Response @@ -84288,9 +84925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -84316,11 +84953,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -84339,9 +84976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *330 - - *331 - - *88 + - *325 + - *326 + - *86 requestBody: required: true content: @@ -84373,16 +85010,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -84404,10 +85041,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *330 - - *331 - - *88 + - *325 - *326 + - *86 + - *321 responses: '204': description: Response @@ -84450,9 +85087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *330 - - *331 - - &573 + - *325 + - *326 + - &570 name: pull_number description: The number that identifies the pull request. in: path @@ -84465,9 +85102,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *568 examples: - default: *572 + default: *569 '304': *37 '404': *6 '406': @@ -84475,8 +85112,8 @@ paths: content: application/json: schema: *3 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84502,9 +85139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -84546,9 +85183,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *568 examples: - default: *572 + default: *569 '422': *15 '403': *29 x-github: @@ -84570,9 +85207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -84632,21 +85269,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84672,10 +85309,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *330 - - *331 - - *573 - - *96 + - *325 + - *326 + - *570 + - *94 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -84685,7 +85322,7 @@ paths: enum: - asc - desc - - *79 + - *77 - *17 - *19 responses: @@ -84695,11 +85332,11 @@ paths: application/json: schema: type: array - items: *569 + items: *566 examples: - default: *574 + default: *571 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84730,9 +85367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -84837,7 +85474,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: example-for-a-multi-line-comment: value: @@ -84925,10 +85562,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *330 - - *331 - - *573 - - *88 + - *325 + - *326 + - *570 + - *86 requestBody: required: true content: @@ -84950,7 +85587,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *566 examples: default: value: @@ -85036,9 +85673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -85048,11 +85685,11 @@ paths: application/json: schema: type: array - items: *462 + items: *457 examples: - default: *575 + default: *572 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85080,9 +85717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -85092,7 +85729,7 @@ paths: application/json: schema: type: array - items: *475 + items: *470 examples: default: value: @@ -85108,10 +85745,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *58 + Link: *54 '422': *15 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85130,9 +85767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 responses: '204': description: Response if pull request has been merged @@ -85155,9 +85792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -85268,9 +85905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 responses: '200': description: Response @@ -85286,7 +85923,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *178 required: - users - teams @@ -85327,7 +85964,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85345,9 +85982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -85384,7 +86021,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *461 examples: default: value: @@ -85920,9 +86557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: true content: @@ -85956,7 +86593,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *461 examples: default: value: @@ -86461,9 +87098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 - *17 - *19 responses: @@ -86473,7 +87110,7 @@ paths: application/json: schema: type: array - items: &576 + items: &573 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86542,7 +87179,7 @@ paths: type: string body_text: type: string - author_association: *72 + author_association: *71 required: - id - node_id @@ -86591,7 +87228,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86624,9 +87261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -86712,9 +87349,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: &578 + default: &575 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86777,10 +87414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - &577 + - *325 + - *326 + - *570 + - &574 name: review_id description: The unique identifier of the review. in: path @@ -86792,9 +87429,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: &579 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86853,10 +87490,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -86879,7 +87516,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: default: value: @@ -86941,18 +87578,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 responses: '200': description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *578 + default: *575 '422': *7 '404': *6 x-github: @@ -86979,10 +87616,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 - *17 - *19 responses: @@ -87061,13 +87698,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *72 + author_association: *71 _links: type: object properties: - self: *252 - html: *252 - pull_request: *252 + self: *258 + html: *258 + pull_request: *258 required: - self - html @@ -87076,7 +87713,7 @@ paths: type: string body_html: type: string - reactions: *73 + reactions: *72 side: description: The side of the first line of the range for a multi-line comment. @@ -87188,7 +87825,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -87217,10 +87854,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -87248,7 +87885,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: default: value: @@ -87311,10 +87948,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *330 - - *331 - - *573 - - *577 + - *325 + - *326 + - *570 + - *574 requestBody: required: true content: @@ -87349,9 +87986,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *579 + default: *576 '404': *6 '422': *7 '403': *29 @@ -87373,9 +88010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *330 - - *331 - - *573 + - *325 + - *326 + - *570 requestBody: required: false content: @@ -87438,8 +88075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *330 - - *331 + - *325 + - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87452,9 +88089,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: - default: &581 + default: &578 value: type: file encoding: base64 @@ -87496,8 +88133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *330 - - *331 + - *325 + - *326 - name: dir description: The alternate path to look for a README file in: path @@ -87517,9 +88154,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: - default: *581 + default: *578 '404': *6 '422': *15 x-github: @@ -87541,8 +88178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -87552,7 +88189,7 @@ paths: application/json: schema: type: array - items: *582 + items: *579 examples: default: value: @@ -87626,7 +88263,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -87646,8 +88283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -87723,9 +88360,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: &586 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87830,9 +88467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *330 - - *331 - - &584 + - *325 + - *326 + - &581 name: asset_id description: The unique identifier of the asset. in: path @@ -87844,9 +88481,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *580 examples: - default: &585 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87881,7 +88518,7 @@ paths: type: User site_admin: false '404': *6 - '302': *477 + '302': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87897,9 +88534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *330 - - *331 - - *584 + - *325 + - *326 + - *581 requestBody: required: false content: @@ -87927,9 +88564,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *580 examples: - default: *585 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87945,9 +88582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *330 - - *331 - - *584 + - *325 + - *326 + - *581 responses: '204': description: Response @@ -87971,8 +88608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -88057,16 +88694,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88083,8 +88720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *330 - - *331 + - *325 + - *326 - name: tag description: tag parameter in: path @@ -88097,9 +88734,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -88121,9 +88758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *330 - - *331 - - &587 + - *325 + - *326 + - &584 name: release_id description: The unique identifier of the release. in: path @@ -88137,9 +88774,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '401': description: Unauthorized x-github: @@ -88157,9 +88794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 requestBody: required: false content: @@ -88223,9 +88860,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *579 examples: - default: *586 + default: *583 '404': description: Not Found if the discussion category name is invalid content: @@ -88246,9 +88883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 responses: '204': description: Response @@ -88268,9 +88905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - *17 - *19 responses: @@ -88280,7 +88917,7 @@ paths: application/json: schema: type: array - items: *583 + items: *580 examples: default: value: @@ -88317,7 +88954,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88361,9 +88998,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - name: name in: query required: true @@ -88389,7 +89026,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *580 examples: response-for-successful-upload: value: @@ -88444,9 +89081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88470,11 +89107,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -88493,9 +89130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *330 - - *331 - - *587 + - *325 + - *326 + - *584 requestBody: required: true content: @@ -88525,16 +89162,16 @@ paths: description: Reaction exists content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '201': description: Reaction created content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 '422': *15 x-github: githubCloudOnly: false @@ -88556,10 +89193,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *330 - - *331 - - *587 + - *325 - *326 + - *584 + - *321 responses: '204': description: Response @@ -88583,9 +89220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *330 - - *331 - - *400 + - *325 + - *326 + - *395 - *17 - *19 responses: @@ -88601,8 +89238,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *271 - - &588 + - *276 + - &585 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88621,69 +89258,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *272 - - *588 - - allOf: - - *273 - - *588 - - allOf: - - *274 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *275 - - *588 - - allOf: - - *276 - - *588 - allOf: - *277 - - *588 + - *585 - allOf: - *278 - - *588 + - *585 - allOf: - *279 - - *588 + - *585 + - allOf: + - *586 + - *585 - allOf: - *280 - - *588 + - *585 - allOf: - *281 - - *588 + - *585 - allOf: - *282 - - *588 + - *585 - allOf: - *283 - - *588 + - *585 - allOf: - *284 - - *588 + - *585 - allOf: - *285 - - *588 + - *585 - allOf: - *286 - - *588 + - *585 - allOf: - *287 - - *588 + - *585 - allOf: - *288 - - *588 + - *585 - allOf: - *289 - - *588 + - *585 - allOf: - *290 - - *588 + - *585 + - allOf: + - *291 + - *585 + - allOf: + - *292 + - *585 + - allOf: + - *293 + - *585 - allOf: - - *590 - - *588 + - *294 + - *585 + - allOf: + - *295 + - *585 + - allOf: + - *587 + - *585 examples: default: value: @@ -88722,8 +89359,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - name: includes_parents @@ -88734,7 +89371,7 @@ paths: schema: type: boolean default: true - - *591 + - *588 responses: '200': description: Response @@ -88742,7 +89379,7 @@ paths: application/json: schema: type: array - items: *291 + items: *296 examples: default: value: @@ -88773,7 +89410,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -88789,8 +89426,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 requestBody: description: Request body required: true @@ -88810,16 +89447,16 @@ paths: - tag - push default: branch - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *266 + items: *274 + conditions: *271 rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *589 required: - name - enforcement @@ -88850,9 +89487,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &602 + default: &599 value: id: 42 name: super cool ruleset @@ -88885,7 +89522,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *106 + '500': *105 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -88899,12 +89536,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *330 - - *331 + - *325 + - *326 + - *590 + - *591 + - *592 - *593 - - *594 - - *595 - - *596 - *17 - *19 responses: @@ -88912,11 +89549,11 @@ paths: description: Response content: application/json: - schema: *597 + schema: *594 examples: - default: *598 + default: *595 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88935,19 +89572,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *330 - - *331 - - *599 + - *325 + - *326 + - *596 responses: '200': description: Response content: application/json: - schema: *600 + schema: *597 examples: - default: *601 + default: *598 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88973,8 +89610,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -88994,11 +89631,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *602 + default: *599 '404': *6 - '500': *106 + '500': *105 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -89014,8 +89651,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89040,16 +89677,16 @@ paths: - branch - tag - push - enforcement: *268 + enforcement: *273 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *269 - conditions: *266 + items: *274 + conditions: *271 rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *589 examples: default: value: @@ -89077,11 +89714,11 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *602 + default: *599 '404': *6 - '500': *106 + '500': *105 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -89097,8 +89734,8 @@ paths: category: repos subcategory: rules parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89109,7 +89746,7 @@ paths: '204': description: Response '404': *6 - '500': *106 + '500': *105 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -89121,8 +89758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 - name: ruleset_id @@ -89138,11 +89775,11 @@ paths: application/json: schema: type: array - items: *294 + items: *299 examples: - default: *603 + default: *600 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89159,8 +89796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *330 - - *331 + - *325 + - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89178,7 +89815,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *601 examples: default: value: @@ -89211,7 +89848,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89233,21 +89870,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *330 - - *331 - - *295 - - *296 - - *297 - - *298 + - *325 + - *326 + - *602 + - *603 + - *604 + - *605 - *48 - *19 - *17 - - *605 - *606 - - *299 - - *300 - - *301 - - *302 + - *607 + - *608 + - *609 + - *610 + - *611 responses: '200': description: Response @@ -89255,11 +89892,11 @@ paths: application/json: schema: type: array - items: &610 + items: &615 type: object properties: - number: *54 - created_at: *55 + number: *158 + created_at: *159 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89267,15 +89904,15 @@ paths: format: date-time readOnly: true nullable: true - url: *56 - html_url: *57 + url: *161 + html_url: *162 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *607 - resolution: *608 + state: *612 + resolution: *613 resolved_at: type: string format: date-time @@ -89371,7 +90008,7 @@ paths: pull request. ' - oneOf: *609 + oneOf: *614 nullable: true has_more_locations: type: boolean @@ -89498,7 +90135,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89520,16 +90157,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 - - *302 + - *325 + - *326 + - *426 + - *611 responses: '200': description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -89560,7 +90197,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89581,9 +90218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 requestBody: required: true content: @@ -89591,8 +90228,8 @@ paths: schema: type: object properties: - state: *607 - resolution: *608 + state: *612 + resolution: *613 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -89610,7 +90247,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -89663,7 +90300,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89685,9 +90322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *330 - - *331 - - *431 + - *325 + - *326 + - *426 - *19 - *17 responses: @@ -89698,7 +90335,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &769 + items: &773 type: object properties: type: @@ -89724,11 +90361,6 @@ paths: example: commit details: oneOf: - - *611 - - *612 - - *613 - - *614 - - *615 - *616 - *617 - *618 @@ -89737,6 +90369,11 @@ paths: - *621 - *622 - *623 + - *624 + - *625 + - *626 + - *627 + - *628 examples: default: value: @@ -89796,11 +90433,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *58 + Link: *54 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89822,8 +90459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -89831,14 +90468,14 @@ paths: schema: type: object properties: - reason: &625 + reason: &630 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *624 + placeholder_id: *629 required: - reason - placeholder_id @@ -89855,7 +90492,7 @@ paths: schema: type: object properties: - reason: *625 + reason: *630 expire_at: type: string format: date-time @@ -89878,7 +90515,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *77 + '503': *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89890,6 +90527,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -89898,13 +90538,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *77 + '503': *106 '200': description: Response content: @@ -89914,7 +90554,7 @@ paths: properties: incremental_scans: type: array - items: &626 + items: &631 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89940,15 +90580,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *626 + items: *631 backfill_scans: type: array - items: *626 + items: *631 custom_pattern_backfill_scans: type: array items: allOf: - - *626 + - *631 - type: object properties: pattern_name: @@ -90018,8 +90658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *330 - - *331 + - *325 + - *326 - *48 - name: sort description: The property to sort the results by. @@ -90063,9 +90703,9 @@ paths: application/json: schema: type: array - items: *627 + items: *632 examples: - default: *628 + default: *633 '400': *14 '404': *6 x-github: @@ -90088,8 +90728,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -90162,7 +90802,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 required: - login - type @@ -90249,9 +90889,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: &630 + default: &635 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90484,8 +91124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -90589,7 +91229,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: default: value: @@ -90736,17 +91376,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '200': description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: *630 + default: *635 '403': *29 '404': *6 x-github: @@ -90770,9 +91410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 requestBody: required: true content: @@ -90845,7 +91485,7 @@ paths: login: type: string description: The username of the user credited. - type: *307 + type: *302 required: - login - type @@ -90931,10 +91571,10 @@ paths: description: Response content: application/json: - schema: *627 + schema: *632 examples: - default: *630 - add_credit: *630 + default: *635 + add_credit: *635 '403': *29 '404': *6 '422': @@ -90972,9 +91612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '202': *39 '400': *14 @@ -91001,17 +91641,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *330 - - *331 - - *629 + - *325 + - *326 + - *634 responses: '202': description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 '400': *14 '422': *15 '403': *29 @@ -91037,8 +91677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91115,7 +91755,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -91137,8 +91777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91147,7 +91787,7 @@ paths: application/json: schema: type: array - items: &631 + items: &636 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91160,7 +91800,7 @@ paths: - 1124 - -435 '202': *39 - '204': *163 + '204': *172 '422': description: Repository contains more than 10,000 commits x-github: @@ -91180,8 +91820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91230,7 +91870,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91257,8 +91897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91332,7 +91972,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91354,8 +91994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91509,8 +92149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91520,7 +92160,7 @@ paths: application/json: schema: type: array - items: *631 + items: *636 examples: default: value: @@ -91533,7 +92173,7 @@ paths: - - 0 - 2 - 21 - '204': *163 + '204': *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91553,8 +92193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *330 - - *331 + - *325 + - *326 - name: sha in: path required: true @@ -91608,7 +92248,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *637 examples: default: value: @@ -91662,8 +92302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91675,9 +92315,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91695,14 +92335,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &633 + schema: &638 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91770,8 +92410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: false content: @@ -91797,7 +92437,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *638 examples: default: value: @@ -91824,8 +92464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -91845,8 +92485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -91902,7 +92542,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91925,8 +92565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -91934,7 +92574,7 @@ paths: application/json: schema: type: array - items: &634 + items: &639 title: Tag protection description: Tag protection type: object @@ -91986,8 +92626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92010,7 +92650,7 @@ paths: description: Response content: application/json: - schema: *634 + schema: *639 examples: default: value: @@ -92041,8 +92681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92079,8 +92719,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *330 - - *331 + - *325 + - *326 - name: ref in: path required: true @@ -92116,8 +92756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *330 - - *331 + - *325 + - *326 - *17 - *19 responses: @@ -92127,11 +92767,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - default: *227 + default: *233 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -92149,8 +92789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *330 - - *331 + - *325 + - *326 - *19 - *17 responses: @@ -92158,7 +92798,7 @@ paths: description: Response content: application/json: - schema: &635 + schema: &640 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92170,7 +92810,7 @@ paths: required: - names examples: - default: &636 + default: &641 value: names: - octocat @@ -92193,8 +92833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92225,9 +92865,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *640 examples: - default: *636 + default: *641 '404': *6 '422': *7 x-github: @@ -92248,9 +92888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *330 - - *331 - - &637 + - *325 + - *326 + - &642 name: per description: The time frame to display results for. in: query @@ -92279,7 +92919,7 @@ paths: example: 128 clones: type: array - items: &638 + items: &643 title: Traffic type: object properties: @@ -92366,8 +93006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -92457,8 +93097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *330 - - *331 + - *325 + - *326 responses: '200': description: Response @@ -92518,9 +93158,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *330 - - *331 - - *637 + - *325 + - *326 + - *642 responses: '200': description: Response @@ -92539,7 +93179,7 @@ paths: example: 3782 views: type: array - items: *638 + items: *643 required: - uniques - count @@ -92616,8 +93256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *330 - - *331 + - *325 + - *326 requestBody: required: true content: @@ -92653,7 +93293,7 @@ paths: description: Response content: application/json: - schema: *137 + schema: *142 examples: default: value: @@ -92891,8 +93531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92915,8 +93555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -92938,8 +93578,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -92965,8 +93605,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *330 - - *331 + - *325 + - *326 - name: ref in: path required: true @@ -93058,9 +93698,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93101,7 +93741,7 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: default: value: @@ -93290,7 +93930,7 @@ paths: html_url: type: string format: uri - repository: *137 + repository: *142 score: type: number file_size: @@ -93308,7 +93948,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &639 + text_matches: &644 title: Search Result Text Matches type: array items: @@ -93422,7 +94062,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *77 + '503': *106 '422': *15 '403': *29 x-github: @@ -93470,7 +94110,7 @@ paths: enum: - author-date - committer-date - - &640 + - &645 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93541,7 +94181,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true comment_count: type: integer @@ -93561,7 +94201,7 @@ paths: url: type: string format: uri - verification: *513 + verification: *508 required: - author - committer @@ -93580,7 +94220,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *398 + properties: *393 nullable: true parents: type: array @@ -93593,12 +94233,12 @@ paths: type: string sha: type: string - repository: *137 + repository: *142 score: type: number node_id: type: string - text_matches: *639 + text_matches: *644 required: - sha - node_id @@ -93790,7 +94430,7 @@ paths: - interactions - created - updated - - *640 + - *645 - *17 - *19 - name: advanced_search @@ -93887,11 +94527,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: type: string state_reason: @@ -93908,8 +94548,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *250 - required: *251 + properties: *256 + required: *257 nullable: true comments: type: integer @@ -93923,7 +94563,7 @@ paths: type: string format: date-time nullable: true - text_matches: *639 + text_matches: *644 pull_request: type: object properties: @@ -93956,10 +94596,10 @@ paths: type: string score: type: number - author_association: *72 + author_association: *71 draft: type: boolean - repository: *67 + repository: *66 body_html: type: string body_text: @@ -93967,7 +94607,7 @@ paths: timeline_url: type: string format: uri - type: *209 + type: *216 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -93977,9 +94617,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 - reactions: *73 + properties: *67 + required: *68 + reactions: *72 required: - assignee - closed_at @@ -94095,7 +94735,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *77 + '503': *106 '422': *15 '304': *37 '403': *29 @@ -94148,7 +94788,7 @@ paths: enum: - created - updated - - *640 + - *645 - *17 - *19 responses: @@ -94192,7 +94832,7 @@ paths: nullable: true score: type: number - text_matches: *639 + text_matches: *644 required: - id - node_id @@ -94277,7 +94917,7 @@ paths: - forks - help-wanted-issues - updated - - *640 + - *645 - *17 - *19 responses: @@ -94496,8 +95136,8 @@ paths: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true permissions: type: object @@ -94516,7 +95156,7 @@ paths: - admin - pull - push - text_matches: *639 + text_matches: *644 temp_clone_token: type: string allow_merge_commit: @@ -94718,7 +95358,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *77 + '503': *106 '422': *15 '304': *37 x-github: @@ -94816,7 +95456,7 @@ paths: type: string format: uri nullable: true - text_matches: *639 + text_matches: *644 related: type: array nullable: true @@ -95007,7 +95647,7 @@ paths: - followers - repositories - joined - - *640 + - *645 - *17 - *19 responses: @@ -95111,7 +95751,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *639 + text_matches: *644 blog: type: string nullable: true @@ -95170,7 +95810,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *77 + '503': *106 '422': *15 x-github: githubCloudOnly: false @@ -95190,7 +95830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &644 + - &649 name: team_id description: The unique identifier of the team. in: path @@ -95202,9 +95842,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 x-github: githubCloudOnly: false @@ -95231,7 +95871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *644 + - *649 requestBody: required: true content: @@ -95294,16 +95934,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '201': description: Response content: application/json: - schema: *315 + schema: *310 examples: - default: *316 + default: *311 '404': *6 '422': *15 '403': *29 @@ -95331,7 +95971,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *644 + - *649 responses: '204': description: Response @@ -95362,7 +96002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *644 + - *649 - *48 - *17 - *19 @@ -95373,11 +96013,11 @@ paths: application/json: schema: type: array - items: *317 + items: *312 examples: - default: *645 + default: *650 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95404,7 +96044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *644 + - *649 requestBody: required: true content: @@ -95438,9 +96078,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: triggersNotification: true githubCloudOnly: false @@ -95467,16 +96107,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 responses: '200': description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95501,8 +96141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: false content: @@ -95525,9 +96165,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *646 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95552,8 +96192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 responses: '204': description: Response @@ -95582,8 +96222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *644 - - *319 + - *649 + - *314 - *48 - *17 - *19 @@ -95594,11 +96234,11 @@ paths: application/json: schema: type: array - items: *320 + items: *315 examples: - default: *647 + default: *652 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95625,8 +96265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: true content: @@ -95648,9 +96288,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: triggersNotification: true githubCloudOnly: false @@ -95677,17 +96317,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 responses: '200': description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *321 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95712,9 +96352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 requestBody: required: true content: @@ -95736,9 +96376,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *315 examples: - default: *648 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95763,9 +96403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 responses: '204': description: Response @@ -95794,9 +96434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -95822,11 +96462,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95853,9 +96493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *644 - - *319 - - *322 + - *649 + - *314 + - *317 requestBody: required: true content: @@ -95887,9 +96527,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95915,8 +96555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -95942,11 +96582,11 @@ paths: application/json: schema: type: array - items: *323 + items: *318 examples: - default: *325 + default: *320 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95973,8 +96613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *644 - - *319 + - *649 + - *314 requestBody: required: true content: @@ -96006,9 +96646,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *318 examples: - default: *324 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96032,7 +96672,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96042,11 +96682,11 @@ paths: application/json: schema: type: array - items: *206 + items: *213 examples: - default: *207 + default: *214 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96070,7 +96710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *644 + - *649 - name: role description: Filters members returned by their role in the team. in: query @@ -96093,9 +96733,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96121,8 +96761,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: if user is a member @@ -96158,8 +96798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96198,8 +96838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96235,16 +96875,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '200': description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-user-is-a-team-maintainer: *649 + response-if-user-is-a-team-maintainer: *654 '404': *6 x-github: githubCloudOnly: false @@ -96277,8 +96917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 requestBody: required: false content: @@ -96303,9 +96943,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *322 examples: - response-if-users-membership-with-team-is-now-pending: *650 + response-if-users-membership-with-team-is-now-pending: *655 '403': description: Forbidden if team synchronization is set up '422': @@ -96339,8 +96979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *644 - - *63 + - *649 + - *59 responses: '204': description: Response @@ -96368,7 +97008,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96378,11 +97018,11 @@ paths: application/json: schema: type: array - items: *328 + items: *323 examples: - default: *651 + default: *656 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96406,16 +97046,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *644 - - *329 + - *649 + - *324 responses: '200': description: Response content: application/json: - schema: *328 + schema: *323 examples: - default: *652 + default: *657 '404': description: Not Found if project is not managed by this team x-github: @@ -96439,8 +97079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *644 - - *329 + - *649 + - *324 requestBody: required: false content: @@ -96507,8 +97147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *644 - - *329 + - *649 + - *324 responses: '204': description: Response @@ -96535,7 +97175,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96545,11 +97185,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -96577,15 +97217,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *653 + schema: *658 examples: alternative-response-with-extra-repository-information: value: @@ -96736,9 +97376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 requestBody: required: false content: @@ -96788,9 +97428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *644 - - *330 - - *331 + - *649 + - *325 + - *326 responses: '204': description: Response @@ -96815,7 +97455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *644 + - *649 - *17 - *19 responses: @@ -96825,11 +97465,11 @@ paths: application/json: schema: type: array - items: *169 + items: *178 examples: - response-if-child-teams-exist: *654 + response-if-child-teams-exist: *659 headers: - Link: *58 + Link: *54 '404': *6 '403': *29 '422': *15 @@ -96860,7 +97500,7 @@ paths: application/json: schema: oneOf: - - &656 + - &661 title: Private User description: Private User type: object @@ -97063,7 +97703,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *655 + - *660 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97216,7 +97856,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *661 examples: default: value: @@ -97295,7 +97935,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 '304': *37 '404': *6 '403': *29 @@ -97318,7 +97958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *63 + - *59 responses: '204': description: If the user is blocked @@ -97346,7 +97986,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -97370,7 +98010,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -97419,11 +98059,11 @@ paths: type: integer codespaces: type: array - items: *214 + items: *221 examples: - default: *215 + default: *222 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -97560,21 +98200,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 - '503': *77 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97614,7 +98254,7 @@ paths: type: integer secrets: type: array - items: &657 + items: &662 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97654,9 +98294,9 @@ paths: - visibility - selected_repositories_url examples: - default: *454 + default: *449 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97724,13 +98364,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 responses: '200': description: Response content: application/json: - schema: *657 + schema: *662 examples: default: value: @@ -97760,7 +98400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 requestBody: required: true content: @@ -97805,7 +98445,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -97833,7 +98473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *145 + - *150 responses: '204': description: Response @@ -97858,7 +98498,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *145 + - *150 responses: '200': description: Response @@ -97874,13 +98514,13 @@ paths: type: integer repositories: type: array - items: *137 + items: *142 examples: - default: *658 + default: *663 '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97901,7 +98541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *145 + - *150 requestBody: required: true content: @@ -97933,7 +98573,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97955,7 +98595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *145 + - *150 - name: repository_id in: path required: true @@ -97967,7 +98607,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97988,7 +98628,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *145 + - *150 - name: repository_id in: path required: true @@ -98000,7 +98640,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *106 + '500': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98020,17 +98660,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98054,7 +98694,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 requestBody: required: false content: @@ -98084,9 +98724,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '401': *25 '403': *29 '404': *6 @@ -98108,11 +98748,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '202': *39 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98137,13 +98777,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '202': description: Response content: application/json: - schema: &659 + schema: &664 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98184,7 +98824,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &660 + default: &665 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98192,7 +98832,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98216,7 +98856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *216 + - *223 - name: export_id in: path required: true @@ -98229,9 +98869,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *664 examples: - default: *660 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -98252,7 +98892,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *216 + - *223 responses: '200': description: Response @@ -98268,11 +98908,11 @@ paths: type: integer machines: type: array - items: *661 + items: *666 examples: - default: *662 + default: *667 '304': *37 - '500': *106 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -98299,7 +98939,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *216 + - *223 requestBody: required: true content: @@ -98349,13 +98989,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *338 + repository: *333 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *452 - required: *453 + properties: *447 + required: *448 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99129,17 +99769,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 + default: *446 '304': *37 - '500': *106 + '500': *105 '400': *14 '401': *25 '402': @@ -99169,16 +99809,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *216 + - *223 responses: '200': description: Response content: application/json: - schema: *214 + schema: *221 examples: - default: *451 - '500': *106 + default: *446 + '500': *105 '401': *25 '403': *29 '404': *6 @@ -99207,9 +99847,9 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: &674 + default: &678 value: - id: 197 name: hello_docker @@ -99310,7 +99950,7 @@ paths: application/json: schema: type: array - items: &663 + items: &668 title: Email description: Email type: object @@ -99375,16 +100015,16 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: - default: &676 + default: &680 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -99452,7 +100092,7 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: default: value: @@ -99562,9 +100202,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -99595,9 +100235,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -99617,7 +100257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *63 + - *59 responses: '204': description: if the person is followed by the authenticated user @@ -99647,7 +100287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -99672,7 +100312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *63 + - *59 responses: '204': description: Response @@ -99708,7 +100348,7 @@ paths: application/json: schema: type: array - items: &664 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -99839,7 +100479,7 @@ paths: - subkeys - revoked examples: - default: &690 + default: &694 value: - id: 3 name: Octocat's GPG Key @@ -99871,7 +100511,7 @@ paths: revoked: false raw_key: string headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -99924,9 +100564,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *669 examples: - default: &665 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -99983,7 +100623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &666 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -99995,9 +100635,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *669 examples: - default: *665 + default: *670 '404': *6 '304': *37 '403': *29 @@ -100020,7 +100660,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *666 + - *671 responses: '204': description: Response @@ -100163,7 +100803,7 @@ paths: suspended_at: suspended_by: headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -100209,11 +100849,11 @@ paths: type: string repositories: type: array - items: *67 + items: *66 examples: - default: *129 + default: *134 headers: - Link: *58 + Link: *54 '404': *6 '403': *29 '304': *37 @@ -100236,7 +100876,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *126 + - *131 responses: '204': description: Response @@ -100262,7 +100902,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *126 + - *131 responses: '204': description: Response @@ -100296,12 +100936,12 @@ paths: application/json: schema: anyOf: - - *204 + - *211 - type: object properties: {} additionalProperties: false examples: - default: *205 + default: *212 '204': description: Response when there are no restrictions x-github: @@ -100325,7 +100965,7 @@ paths: required: true content: application/json: - schema: *524 + schema: *519 examples: default: value: @@ -100336,7 +100976,7 @@ paths: description: Response content: application/json: - schema: *204 + schema: *211 examples: default: value: @@ -100417,7 +101057,7 @@ paths: - closed - all default: open - - *212 + - *219 - name: sort description: What to sort results by. in: query @@ -100430,7 +101070,7 @@ paths: - comments default: created - *48 - - *79 + - *77 - *17 - *19 responses: @@ -100440,11 +101080,11 @@ paths: application/json: schema: type: array - items: *71 + items: *70 examples: - default: *213 + default: *220 headers: - Link: *58 + Link: *54 '404': *6 '304': *37 x-github: @@ -100475,7 +101115,7 @@ paths: application/json: schema: type: array - items: &667 + items: &672 title: Key description: Key type: object @@ -100526,7 +101166,7 @@ paths: verified: false read_only: false headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -100576,9 +101216,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *672 examples: - default: &668 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100611,15 +101251,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *552 + - *547 responses: '200': description: Response content: application/json: - schema: *667 + schema: *672 examples: - default: *668 + default: *673 '404': *6 '304': *37 '403': *29 @@ -100642,7 +101282,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *552 + - *547 responses: '204': description: Response @@ -100675,7 +101315,7 @@ paths: application/json: schema: type: array - items: &669 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100732,7 +101372,7 @@ paths: - id - type - login - plan: *90 + plan: *88 required: - billing_cycle - next_billing_date @@ -100743,7 +101383,7 @@ paths: - account - plan examples: - default: &670 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100776,7 +101416,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *58 + Link: *54 '304': *37 '401': *25 '404': *6 @@ -100805,11 +101445,11 @@ paths: application/json: schema: type: array - items: *669 + items: *674 examples: - default: *670 + default: *675 headers: - Link: *58 + Link: *54 '304': *37 '401': *25 x-github: @@ -100847,7 +101487,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -100924,7 +101564,7 @@ paths: type: User site_admin: false headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -100949,13 +101589,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *105 + - *63 responses: '200': description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -101013,7 +101653,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *105 + - *63 requestBody: required: true content: @@ -101038,7 +101678,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -101106,7 +101746,7 @@ paths: application/json: schema: type: array - items: *221 + items: *227 examples: default: value: @@ -101259,7 +101899,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -101359,7 +101999,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -101539,7 +102179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *222 + - *228 - name: exclude in: query required: false @@ -101552,7 +102192,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *227 examples: default: value: @@ -101746,7 +102386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *222 + - *228 responses: '302': description: Response @@ -101772,7 +102412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *222 + - *228 responses: '204': description: Response @@ -101801,8 +102441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *222 - - *671 + - *228 + - *676 responses: '204': description: Response @@ -101826,7 +102466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *222 + - *228 - *17 - *19 responses: @@ -101836,11 +102476,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '404': *6 x-github: githubCloudOnly: false @@ -101873,11 +102513,11 @@ paths: application/json: schema: type: array - items: *218 + items: *61 examples: - default: *672 + default: *101 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -101917,7 +102557,7 @@ paths: - docker - nuget - container - - *673 + - *677 - *19 - *17 responses: @@ -101927,10 +102567,10 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 - '400': *675 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101950,16 +102590,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: - default: &691 + default: &695 value: id: 40201 name: octo-name @@ -102072,8 +102712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 responses: '204': description: Response @@ -102103,8 +102743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 - name: token description: package token schema: @@ -102136,8 +102776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *230 - - *231 + - *236 + - *237 - *19 - *17 - name: state @@ -102157,7 +102797,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -102206,15 +102846,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -102250,9 +102890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '204': description: Response @@ -102282,9 +102922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *230 - - *231 - - *233 + - *236 + - *237 + - *239 responses: '204': description: Response @@ -102340,7 +102980,7 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: default: value: @@ -102412,11 +103052,11 @@ paths: application/json: schema: type: array - items: *663 + items: *668 examples: - default: *676 + default: *680 headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -102525,9 +103165,9 @@ paths: application/json: schema: type: array - items: *67 + items: *66 examples: - default: &683 + default: &687 summary: Default response value: - id: 1296269 @@ -102648,7 +103288,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '422': *15 '304': *37 '403': *29 @@ -102831,9 +103471,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *333 examples: - default: *340 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102871,11 +103511,11 @@ paths: application/json: schema: type: array - items: *526 + items: *521 examples: - default: *677 + default: *681 headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -102896,7 +103536,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *208 + - *215 responses: '204': description: Response @@ -102919,7 +103559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *208 + - *215 responses: '204': description: Response @@ -102952,7 +103592,7 @@ paths: application/json: schema: type: array - items: &678 + items: &682 title: Social account description: Social media account type: object @@ -102967,12 +103607,12 @@ paths: - provider - url examples: - default: &679 + default: &683 value: - provider: twitter url: https://twitter.com/github headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103029,9 +103669,9 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 '422': *15 '304': *37 '404': *6 @@ -103118,7 +103758,7 @@ paths: application/json: schema: type: array - items: &680 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103138,7 +103778,7 @@ paths: - title - created_at examples: - default: &705 + default: &709 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103151,7 +103791,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103204,9 +103844,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: &681 + default: &685 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103237,7 +103877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &682 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103249,9 +103889,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *684 examples: - default: *681 + default: *685 '404': *6 '304': *37 '403': *29 @@ -103274,7 +103914,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *682 + - *686 responses: '204': description: Response @@ -103303,7 +103943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &706 + - &710 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -103326,13 +103966,13 @@ paths: application/json: schema: type: array - items: *67 + items: *66 examples: - default-response: *683 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &707 + items: &711 title: Starred Repository description: Starred Repository type: object @@ -103340,7 +103980,7 @@ paths: starred_at: type: string format: date-time - repo: *67 + repo: *66 required: - starred_at - repo @@ -103468,7 +104108,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -103488,8 +104128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response if this repository is starred by you @@ -103517,8 +104157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -103542,8 +104182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *330 - - *331 + - *325 + - *326 responses: '204': description: Response @@ -103576,11 +104216,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -103615,7 +104255,7 @@ paths: application/json: schema: type: array - items: *315 + items: *310 examples: default: value: @@ -103666,7 +104306,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *58 + Link: *54 '304': *37 '404': *6 '403': *29 @@ -103693,7 +104333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *92 + - *90 responses: '200': description: Response @@ -103701,10 +104341,10 @@ paths: application/json: schema: oneOf: - - *656 - - *655 + - *661 + - *660 examples: - default-response: &685 + default-response: &689 summary: Default response value: login: octocat @@ -103739,7 +104379,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &686 + response-with-git-hub-plan-information: &690 summary: Response with GitHub plan information value: login: octocat @@ -103799,7 +104439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *684 + - *688 - *17 responses: '200': @@ -103810,7 +104450,7 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: Link: example: ; rel="next" @@ -103840,7 +104480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *63 + - *59 responses: '200': description: Response @@ -103848,11 +104488,11 @@ paths: application/json: schema: oneOf: - - *656 - - *655 + - *661 + - *660 examples: - default-response: *685 - response-with-git-hub-plan-information: *686 + default-response: *689 + response-with-git-hub-plan-information: *690 '404': *6 x-github: githubCloudOnly: false @@ -103878,7 +104518,7 @@ paths: - *17 - *40 - *41 - - *63 + - *59 requestBody: required: true content: @@ -103901,8 +104541,8 @@ paths: required: - subject_digests examples: - default: *687 - withPredicateType: *688 + default: *691 + withPredicateType: *692 responses: '200': description: Response @@ -103955,7 +104595,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *689 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103973,7 +104613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *63 + - *59 requestBody: required: true content: @@ -104038,7 +104678,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *63 + - *59 - name: subject_digest description: Subject Digest in: path @@ -104069,7 +104709,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *63 + - *59 - name: attestation_id description: Attestation ID in: path @@ -104107,7 +104747,7 @@ paths: - *17 - *40 - *41 - - *63 + - *59 - name: subject_digest description: Subject Digest in: path @@ -104159,12 +104799,12 @@ paths: initiator: type: string examples: - default: *394 + default: *389 '201': description: Response content: application/json: - schema: *146 + schema: *151 examples: default: value: @@ -104190,7 +104830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *63 + - *59 responses: '200': description: Response @@ -104198,9 +104838,9 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 + default: *678 '403': *29 '401': *25 x-github: @@ -104223,7 +104863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104233,7 +104873,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104295,8 +104935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: + - *59 - *63 - - *105 - *17 - *19 responses: @@ -104306,7 +104946,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104383,7 +105023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104393,7 +105033,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -104451,7 +105091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104463,9 +105103,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104482,7 +105122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104494,9 +105134,9 @@ paths: type: array items: *4 examples: - default: *62 + default: *58 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104513,7 +105153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *63 + - *59 - name: target_user in: path required: true @@ -104540,8 +105180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *63 - - *79 + - *59 + - *77 - *17 - *19 responses: @@ -104551,11 +105191,11 @@ paths: application/json: schema: type: array - items: *80 + items: *78 examples: - default: *81 + default: *79 headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -104574,7 +105214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104584,11 +105224,11 @@ paths: application/json: schema: type: array - items: *664 + items: *669 examples: - default: *690 + default: *694 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104610,7 +105250,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *63 + - *59 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -104682,7 +105322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *63 + - *59 responses: '200': description: Response @@ -104690,7 +105330,7 @@ paths: application/json: schema: *22 examples: - default: *523 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104708,7 +105348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104743,7 +105383,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104763,7 +105403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -104773,11 +105413,11 @@ paths: application/json: schema: type: array - items: *218 + items: *61 examples: - default: *672 + default: *101 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104814,8 +105454,8 @@ paths: - docker - nuget - container - - *673 - - *63 + - *677 + - *59 - *19 - *17 responses: @@ -104825,12 +105465,12 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: - default: *674 + default: *678 '403': *29 '401': *25 - '400': *675 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104850,17 +105490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: - default: *691 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104881,9 +105521,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '204': description: Response @@ -104915,9 +105555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 - name: token description: package token schema: @@ -104949,9 +105589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *230 - - *231 - - *63 + - *236 + - *237 + - *59 responses: '200': description: Response @@ -104959,7 +105599,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -105017,16 +105657,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *230 - - *231 - - *233 - - *63 + - *236 + - *237 + - *239 + - *59 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -105061,10 +105701,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *230 - - *231 - - *63 - - *233 + - *236 + - *237 + - *59 + - *239 responses: '204': description: Response @@ -105096,10 +105736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *230 - - *231 - - *63 - - *233 + - *236 + - *237 + - *59 + - *239 responses: '204': description: Response @@ -105125,7 +105765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *63 + - *59 - name: state description: Indicates the state of the projects to return. in: query @@ -105146,7 +105786,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -105182,7 +105822,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *58 + Link: *54 '422': *15 x-github: githubCloudOnly: false @@ -105204,7 +105844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *63 + - *59 - name: q description: Limit results to projects of the specified type. in: query @@ -105221,11 +105861,11 @@ paths: application/json: schema: type: array - items: *245 + items: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105245,18 +105885,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *247 - - *63 + - *253 + - *59 responses: '200': description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *246 + default: *252 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105276,8 +105916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *247 - - *63 + - *253 + - *59 - *17 - *40 - *41 @@ -105288,11 +105928,11 @@ paths: application/json: schema: type: array - items: *248 + items: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105312,19 +105952,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *247 - - *692 - - *63 + - *253 + - *696 + - *59 responses: '200': description: Response content: application/json: - schema: *248 + schema: *254 examples: - default: *249 + default: *255 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105345,8 +105985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *247 - - *63 + - *253 + - *59 - *40 - *41 - *17 @@ -105358,16 +105998,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -105375,11 +106018,11 @@ paths: application/json: schema: type: array - items: *255 + items: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105398,8 +106041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *63 - - *247 + - *59 + - *253 requestBody: required: true description: Details of the item to add to the project. @@ -105436,10 +106079,10 @@ paths: description: Response content: application/json: - schema: *693 + schema: *697 examples: - issue: *254 - pull_request: *254 + issue: *260 + pull_request: *260 '304': *37 '403': *29 '401': *25 @@ -105459,30 +106102,33 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *255 + schema: *261 examples: - default: *256 + default: *262 headers: - Link: *58 + Link: *54 '304': *37 '403': *29 '401': *25 @@ -105501,9 +106147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -105573,13 +106219,13 @@ paths: description: Response content: application/json: - schema: *255 + schema: *261 examples: - text_field: *256 - number_field: *256 - date_field: *256 - single_select_field: *256 - iteration_field: *256 + text_field: *262 + number_field: *262 + date_field: *262 + single_select_field: *262 + iteration_field: *262 '401': *25 '403': *29 '404': *6 @@ -105599,9 +106245,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *247 - - *63 - - *257 + - *253 + - *59 + - *263 responses: '204': description: Response @@ -105628,7 +106274,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -105638,7 +106284,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -105703,7 +106349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -105713,7 +106359,7 @@ paths: application/json: schema: type: array - items: *98 + items: *96 examples: default: value: @@ -105776,7 +106422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *63 + - *59 - name: type description: Limit results to repositories of the specified type. in: query @@ -105819,11 +106465,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105845,15 +106491,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *694 + schema: *698 examples: - default: *695 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105875,15 +106521,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *696 + schema: *700 examples: - default: *697 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105892,7 +106538,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -105900,12 +106549,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - - *63 + - *59 - *107 - - *698 + - *702 - *108 - - *699 - - *700 + - *703 + - *704 responses: '200': description: Response when getting a billing premium request usage report @@ -105958,19 +106607,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -106012,8 +106661,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106035,15 +106684,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *63 + - *59 responses: '200': description: Response content: application/json: - schema: *701 + schema: *705 examples: - default: *702 + default: *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106063,11 +106712,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *63 + - *59 - *107 - - *703 + - *707 - *108 - - *704 + - *708 responses: '200': description: Response when getting a billing usage report @@ -106137,8 +106786,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *106 - '503': *77 + '500': *105 + '503': *106 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106156,7 +106805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106166,11 +106815,11 @@ paths: application/json: schema: type: array - items: *678 + items: *682 examples: - default: *679 + default: *683 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106188,7 +106837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106198,11 +106847,11 @@ paths: application/json: schema: type: array - items: *680 + items: *684 examples: - default: *705 + default: *709 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106224,8 +106873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *63 - - *706 + - *59 + - *710 - *48 - *17 - *19 @@ -106237,13 +106886,13 @@ paths: schema: anyOf: - type: array - items: *707 + items: *711 - type: array - items: *67 + items: *66 examples: - default-response: *683 + default-response: *687 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106260,7 +106909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *63 + - *59 - *17 - *19 responses: @@ -106270,11 +106919,11 @@ paths: application/json: schema: type: array - items: *137 + items: *142 examples: - default: *234 + default: *240 headers: - Link: *58 + Link: *54 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106400,7 +107049,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &708 + enterprise: &712 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106458,7 +107107,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &709 + installation: &713 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106477,7 +107126,7 @@ x-webhooks: required: - id - node_id - organization: &710 + organization: &714 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106537,13 +107186,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &711 + repository: &715 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &741 + properties: &745 id: description: Unique identifier of the repository example: 42 @@ -106563,8 +107212,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *74 - required: *75 + properties: *73 + required: *74 nullable: true organization: title: Simple User @@ -107226,7 +107875,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &742 + required: &746 - archive_url - assignees_url - blobs_url @@ -107377,10 +108026,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -107456,11 +108105,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: &712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: &716 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -107683,11 +108332,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: *712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: *716 sender: *4 required: - action @@ -107870,11 +108519,11 @@ x-webhooks: - everyone required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - rule: *712 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + rule: *716 sender: *4 required: - action @@ -107958,7 +108607,7 @@ x-webhooks: type: string enum: - completed - check_run: &714 + check_run: &718 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108011,8 +108660,8 @@ x-webhooks: type: string pull_requests: type: array - items: *76 - repository: *137 + items: *75 + repository: *142 status: example: completed type: string @@ -108049,7 +108698,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *713 + deployment: *717 details_url: example: https://example.com type: string @@ -108099,7 +108748,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *76 + items: *75 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108134,10 +108783,10 @@ x-webhooks: - output - app - pull_requests - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -108530,11 +109179,11 @@ x-webhooks: type: string enum: - created - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -108930,11 +109579,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 requested_action: description: The action requested by the user. type: object @@ -109339,11 +109988,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *714 - installation: *709 - enterprise: *708 - organization: *710 - repository: *711 + check_run: *718 + installation: *713 + enterprise: *712 + organization: *714 + repository: *715 sender: *4 required: - check_run @@ -110320,10 +110969,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -110993,10 +111642,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -111660,10 +112309,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -111829,7 +112478,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111974,20 +112623,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &715 + commit_oid: &719 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *708 - installation: *709 - organization: *710 - ref: &716 + enterprise: *712 + installation: *713 + organization: *714 + ref: &720 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -112152,7 +112801,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112382,12 +113031,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -112482,7 +113131,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112653,12 +113302,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -112824,7 +113473,7 @@ x-webhooks: required: - login - id - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112990,12 +113639,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -113095,7 +113744,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113263,16 +113912,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *711 + repository: *715 sender: *4 required: - action @@ -113369,7 +114018,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *426 + dismissed_comment: *421 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113509,12 +114158,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *715 - enterprise: *708 - installation: *709 - organization: *710 - ref: *716 - repository: *711 + commit_oid: *719 + enterprise: *712 + installation: *713 + organization: *714 + ref: *720 + repository: *715 sender: *4 required: - action @@ -113771,10 +114420,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -113854,18 +114503,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *710 - pusher_type: &717 + organization: *714 + pusher_type: &721 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &718 + ref: &722 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113875,7 +114524,7 @@ x-webhooks: enum: - tag - branch - repository: *711 + repository: *715 sender: *4 required: - ref @@ -113957,10 +114606,10 @@ x-webhooks: type: string enum: - created - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114045,9 +114694,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114124,10 +114773,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114204,10 +114853,10 @@ x-webhooks: type: string enum: - updated - definition: *258 - enterprise: *708 - installation: *709 - organization: *710 + definition: *264 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -114284,19 +114933,19 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - repository: *711 - organization: *710 + enterprise: *712 + installation: *713 + repository: *715 + organization: *714 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *262 + items: *104 old_property_values: type: array description: The old custom property values for the repository. - items: *262 + items: *104 required: - action - repository @@ -114372,18 +115021,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - pusher_type: *717 - ref: *718 + enterprise: *712 + installation: *713 + organization: *714 + pusher_type: *721 + ref: *722 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *711 + repository: *715 sender: *4 required: - ref @@ -114467,11 +115116,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114555,11 +115204,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114643,11 +115292,11 @@ x-webhooks: type: string enum: - created - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114729,11 +115378,11 @@ x-webhooks: type: string enum: - dismissed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114815,11 +115464,11 @@ x-webhooks: type: string enum: - fixed - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114902,11 +115551,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -114988,11 +115637,11 @@ x-webhooks: type: string enum: - reopened - alert: *482 - installation: *709 - organization: *710 - enterprise: *708 - repository: *711 + alert: *477 + installation: *713 + organization: *714 + enterprise: *712 + repository: *715 sender: *4 required: - action @@ -115069,9 +115718,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - key: &719 + enterprise: *712 + installation: *713 + key: &723 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115107,8 +115756,8 @@ x-webhooks: - verified - created_at - read_only - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -115185,11 +115834,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - key: *719 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + key: *723 + organization: *714 + repository: *715 sender: *4 required: - action @@ -115750,12 +116399,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: &723 + workflow: &727 title: Workflow type: object nullable: true @@ -116481,13 +117130,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *488 + deployment: *483 pull_requests: type: array - items: *571 - repository: *711 - organization: *710 - installation: *709 + items: *568 + repository: *715 + organization: *714 + installation: *713 sender: *4 responses: '200': @@ -116558,7 +117207,7 @@ x-webhooks: type: string enum: - approved - approver: &720 + approver: &724 type: object properties: avatar_url: @@ -116601,11 +117250,11 @@ x-webhooks: type: string comment: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - reviewers: &721 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + reviewers: &725 type: array items: type: object @@ -116684,7 +117333,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &722 + workflow_job_run: &726 type: object properties: conclusion: @@ -117415,18 +118064,18 @@ x-webhooks: type: string enum: - rejected - approver: *720 + approver: *724 comment: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - reviewers: *721 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + reviewers: *725 sender: *4 since: type: string - workflow_job_run: *722 + workflow_job_run: *726 workflow_job_runs: type: array items: @@ -118130,13 +118779,13 @@ x-webhooks: type: string enum: - requested - enterprise: *708 + enterprise: *712 environment: type: string - installation: *709 - organization: *710 - repository: *711 - requestor: &728 + installation: *713 + organization: *714 + repository: *715 + requestor: &732 title: User type: object nullable: true @@ -120035,12 +120684,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Deployment Workflow Run type: object @@ -120720,7 +121369,7 @@ x-webhooks: type: string enum: - answered - answer: &726 + answer: &730 type: object properties: author_association: @@ -120877,11 +121526,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121008,11 +121657,11 @@ x-webhooks: - from required: - category - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121095,11 +121744,11 @@ x-webhooks: type: string enum: - closed - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121181,7 +121830,7 @@ x-webhooks: type: string enum: - created - comment: &725 + comment: &729 type: object properties: author_association: @@ -121338,11 +121987,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121425,12 +122074,12 @@ x-webhooks: type: string enum: - deleted - comment: *725 - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + comment: *729 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121525,12 +122174,12 @@ x-webhooks: - from required: - body - comment: *725 - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + comment: *729 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121614,11 +122263,11 @@ x-webhooks: type: string enum: - created - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121700,11 +122349,11 @@ x-webhooks: type: string enum: - deleted - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121804,11 +122453,11 @@ x-webhooks: type: string required: - from - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -121890,10 +122539,10 @@ x-webhooks: type: string enum: - labeled - discussion: *724 - enterprise: *708 - installation: *709 - label: &727 + discussion: *728 + enterprise: *712 + installation: *713 + label: &731 title: Label type: object properties: @@ -121925,8 +122574,8 @@ x-webhooks: - color - default - description - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122009,11 +122658,11 @@ x-webhooks: type: string enum: - locked - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122095,11 +122744,11 @@ x-webhooks: type: string enum: - pinned - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122181,11 +122830,11 @@ x-webhooks: type: string enum: - reopened - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122270,16 +122919,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *724 - new_repository: *711 + new_discussion: *728 + new_repository: *715 required: - new_discussion - new_repository - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122362,10 +123011,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *724 - old_answer: *726 - organization: *710 - repository: *711 + discussion: *728 + old_answer: *730 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122447,12 +123096,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *724 - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122535,11 +123184,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122621,11 +123270,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *724 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + discussion: *728 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -122698,7 +123347,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *708 + enterprise: *712 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123358,9 +124007,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *709 - organization: *710 - repository: *711 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - forkee @@ -123506,9 +124155,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pages: description: The pages that were updated. type: array @@ -123545,7 +124194,7 @@ x-webhooks: - action - sha - html_url - repository: *711 + repository: *715 sender: *4 required: - pages @@ -123621,10 +124270,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: &729 + organization: *714 + repositories: &733 description: An array of repository objects that the installation can access. type: array @@ -123650,8 +124299,8 @@ x-webhooks: - name - full_name - private - repository: *711 - requester: *728 + repository: *715 + requester: *732 sender: *4 required: - action @@ -123726,11 +124375,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -123806,11 +124455,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -123886,10 +124535,10 @@ x-webhooks: type: string enum: - added - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories_added: &730 + organization: *714 + repositories_added: &734 description: An array of repository objects, which were added to the installation. type: array @@ -123935,15 +124584,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *711 - repository_selection: &731 + repository: *715 + repository_selection: &735 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *728 + requester: *732 sender: *4 required: - action @@ -124022,10 +124671,10 @@ x-webhooks: type: string enum: - removed - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories_added: *730 + organization: *714 + repositories_added: *734 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124052,9 +124701,9 @@ x-webhooks: - name - full_name - private - repository: *711 - repository_selection: *731 - requester: *728 + repository: *715 + repository_selection: *735 + requester: *732 sender: *4 required: - action @@ -124133,11 +124782,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -124315,10 +124964,10 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 target_type: type: string @@ -124397,11 +125046,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *708 + enterprise: *712 installation: *22 - organization: *710 - repositories: *729 - repository: *711 + organization: *714 + repositories: *733 + repository: *715 requester: nullable: true sender: *4 @@ -124525,8 +125174,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *68 - required: *69 + properties: *67 + required: *68 reactions: title: Reactions type: object @@ -124653,8 +125302,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125448,8 +126097,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125465,7 +126114,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -125798,8 +126447,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -125879,7 +126528,7 @@ x-webhooks: type: string enum: - deleted - comment: &732 + comment: &736 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126044,8 +126693,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -126835,8 +127484,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126852,7 +127501,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -127187,8 +127836,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -127268,7 +127917,7 @@ x-webhooks: type: string enum: - edited - changes: &761 + changes: &765 description: The changes to the comment. type: object properties: @@ -127280,9 +127929,9 @@ x-webhooks: type: string required: - from - comment: *732 - enterprise: *708 - installation: *709 + comment: *736 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128075,8 +128724,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128092,7 +128741,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -128425,8 +129074,8 @@ x-webhooks: - state - locked - assignee - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128510,15 +129159,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 + blocked_issue: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - blocking_issue_repo: *67 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + blocking_issue_repo: *66 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128606,15 +129255,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 + blocked_issue: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - blocking_issue_repo: *67 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + blocking_issue_repo: *66 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128701,15 +129350,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 - blocked_issue_repo: *67 + blocked_issue: *70 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128797,15 +129446,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *71 - blocked_issue_repo: *67 + blocked_issue: *70 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *71 - installation: *709 - organization: *710 - repository: *711 + blocking_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -128890,10 +129539,10 @@ x-webhooks: type: string enum: - assigned - assignee: *728 - enterprise: *708 - installation: *709 - issue: &735 + assignee: *732 + enterprise: *712 + installation: *713 + issue: &739 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -129682,11 +130331,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129702,7 +130351,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -129803,8 +130452,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -129884,8 +130533,8 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130679,11 +131328,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130699,7 +131348,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -130935,8 +131584,8 @@ x-webhooks: required: - state - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -131015,8 +131664,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131801,11 +132450,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131821,7 +132470,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -131921,8 +132570,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -132001,8 +132650,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132809,11 +133458,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132829,7 +133478,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -132908,7 +133557,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &733 + milestone: &737 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133046,8 +133695,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -133146,8 +133795,8 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133936,11 +134585,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133953,7 +134602,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -134057,9 +134706,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *727 - organization: *710 - repository: *711 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -134139,8 +134788,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134928,11 +135577,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134945,7 +135594,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -135049,9 +135698,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *727 - organization: *710 - repository: *711 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -135131,8 +135780,8 @@ x-webhooks: type: string enum: - locked - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135944,11 +136593,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135961,7 +136610,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *209 + type: *216 title: description: Title of the issue type: string @@ -136042,8 +136691,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -136122,8 +136771,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136929,11 +137578,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136949,7 +137598,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -137027,9 +137676,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *733 - organization: *710 - repository: *711 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -137897,11 +138546,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137994,7 +138643,7 @@ x-webhooks: required: - login - id - type: *209 + type: *216 required: - id - number @@ -138463,8 +139112,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139253,11 +139902,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139273,7 +139922,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -139373,8 +140022,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -139454,9 +140103,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *708 - installation: *709 - issue: &734 + enterprise: *712 + installation: *713 + issue: &738 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140239,11 +140888,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140259,7 +140908,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -140359,8 +141008,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -140439,8 +141088,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141250,11 +141899,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141348,9 +141997,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *209 - organization: *710 - repository: *711 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142216,11 +142865,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142236,7 +142885,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -142804,11 +143453,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *708 - installation: *709 - issue: *734 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *738 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142888,12 +143537,12 @@ x-webhooks: type: string enum: - typed - enterprise: *708 - installation: *709 - issue: *735 - type: *209 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -142974,7 +143623,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &764 + assignee: &768 title: User type: object nullable: true @@ -143044,11 +143693,11 @@ x-webhooks: required: - login - id - enterprise: *708 - installation: *709 - issue: *735 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + organization: *714 + repository: *715 sender: *4 required: - action @@ -143127,12 +143776,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *708 - installation: *709 - issue: *735 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -143212,8 +143861,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144023,11 +144672,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *641 - issue_dependencies_summary: *642 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *643 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144043,7 +144692,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *209 + type: *216 updated_at: type: string format: date-time @@ -144121,8 +144770,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144202,11 +144851,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *708 - installation: *709 - issue: *734 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *738 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144285,12 +144934,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *708 - installation: *709 - issue: *735 - type: *209 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + issue: *739 + type: *216 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144370,11 +145019,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144452,11 +145101,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144566,11 +145215,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - label: *727 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + label: *731 + organization: *714 + repository: *715 sender: *4 required: - action @@ -144652,9 +145301,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: &736 + enterprise: *712 + installation: *713 + marketplace_purchase: &740 title: Marketplace Purchase type: object required: @@ -144737,8 +145386,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *710 - previous_marketplace_purchase: &737 + organization: *714 + previous_marketplace_purchase: &741 title: Marketplace Purchase type: object properties: @@ -144818,7 +145467,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -144898,10 +145547,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -144984,7 +145633,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -145066,10 +145715,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145151,7 +145800,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *711 + repository: *715 sender: *4 required: - action @@ -145232,8 +145881,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 marketplace_purchase: title: Marketplace Purchase type: object @@ -145315,9 +145964,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *710 - previous_marketplace_purchase: *737 - repository: *711 + organization: *714 + previous_marketplace_purchase: *741 + repository: *715 sender: *4 required: - action @@ -145397,12 +146046,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *708 - installation: *709 - marketplace_purchase: *736 - organization: *710 - previous_marketplace_purchase: *737 - repository: *711 + enterprise: *712 + installation: *713 + marketplace_purchase: *740 + organization: *714 + previous_marketplace_purchase: *741 + repository: *715 sender: *4 required: - action @@ -145504,11 +146153,11 @@ x-webhooks: type: string required: - to - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145608,11 +146257,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145691,11 +146340,11 @@ x-webhooks: type: string enum: - removed - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 sender: *4 required: - action @@ -145773,11 +146422,11 @@ x-webhooks: type: string enum: - added - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 scope: description: The scope of the membership. Currently, can only be `team`. @@ -145853,7 +146502,7 @@ x-webhooks: required: - login - id - team: &738 + team: &742 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146076,11 +146725,11 @@ x-webhooks: type: string enum: - removed - enterprise: *708 - installation: *709 - member: *728 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + member: *732 + organization: *714 + repository: *715 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146157,7 +146806,7 @@ x-webhooks: required: - login - id - team: *738 + team: *742 required: - action - scope @@ -146239,8 +146888,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *709 - merge_group: &740 + installation: *713 + merge_group: &744 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146259,15 +146908,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *739 + head_commit: *743 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146353,10 +147002,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *709 - merge_group: *740 - organization: *710 - repository: *711 + installation: *713 + merge_group: *744 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146429,7 +147078,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 + enterprise: *712 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146538,16 +147187,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *709 - organization: *710 + installation: *713 + organization: *714 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -146628,11 +147277,11 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146711,9 +147360,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - milestone: &743 + enterprise: *712 + installation: *713 + milestone: &747 title: Milestone description: A collection of related issues and pull requests. type: object @@ -146850,8 +147499,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -146930,11 +147579,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147044,11 +147693,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - milestone: *733 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *737 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147128,11 +147777,11 @@ x-webhooks: type: string enum: - opened - enterprise: *708 - installation: *709 - milestone: *743 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + milestone: *747 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147211,11 +147860,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *728 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + blocked_user: *732 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147294,11 +147943,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *728 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + blocked_user: *732 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147377,9 +148026,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - membership: &744 + enterprise: *712 + installation: *713 + membership: &748 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147486,8 +148135,8 @@ x-webhooks: - role - organization_url - user - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147565,11 +148214,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147648,8 +148297,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -147765,10 +148414,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 - user: *728 + user: *732 required: - action - invitation @@ -147846,11 +148495,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -147937,11 +148586,11 @@ x-webhooks: properties: from: type: string - enterprise: *708 - installation: *709 - membership: *744 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + membership: *748 + organization: *714 + repository: *715 sender: *4 required: - action @@ -148017,9 +148666,9 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 package: description: Information about the package. type: object @@ -148518,7 +149167,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &745 + items: &749 title: Ruby Gems metadata type: object properties: @@ -148613,7 +149262,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -148689,9 +149338,9 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 package: description: Information about the package. type: object @@ -149044,7 +149693,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *745 + items: *749 source_url: type: string format: uri @@ -149114,7 +149763,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -149291,12 +149940,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *708 + enterprise: *712 id: type: integer - installation: *709 - organization: *710 - repository: *711 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - id @@ -149373,7 +150022,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &746 + personal_access_token_request: &750 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149519,10 +150168,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *708 - organization: *710 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149599,11 +150248,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *746 - enterprise: *708 - organization: *710 + personal_access_token_request: *750 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149679,11 +150328,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *746 - enterprise: *708 - organization: *710 + personal_access_token_request: *750 + enterprise: *712 + organization: *714 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149758,11 +150407,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *746 - organization: *710 - enterprise: *708 + personal_access_token_request: *750 + organization: *714 + enterprise: *712 sender: *4 - installation: *709 + installation: *713 required: - action - personal_access_token_request @@ -149867,7 +150516,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *747 + last_response: *751 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -149899,8 +150548,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 zen: description: Random string of GitHub zen. @@ -150145,10 +150794,10 @@ x-webhooks: - from required: - note - enterprise: *708 - installation: *709 - organization: *710 - project_card: &748 + enterprise: *712 + installation: *713 + organization: *714 + project_card: &752 title: Project Card type: object properties: @@ -150267,7 +150916,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -150348,11 +150997,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project_card: *748 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_card: *752 + repository: *715 sender: *4 required: - action @@ -150432,9 +151081,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 project_card: title: Project Card type: object @@ -150562,8 +151211,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -150657,11 +151306,11 @@ x-webhooks: - from required: - note - enterprise: *708 - installation: *709 - organization: *710 - project_card: *748 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_card: *752 + repository: *715 sender: *4 required: - action @@ -150755,9 +151404,9 @@ x-webhooks: - from required: - column_id - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 project_card: allOf: - title: Project Card @@ -150947,7 +151596,7 @@ x-webhooks: type: string required: - after_id - repository: *711 + repository: *715 sender: *4 required: - action @@ -151027,10 +151676,10 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - organization: *710 - project: &750 + enterprise: *712 + installation: *713 + organization: *714 + project: &754 title: Project type: object properties: @@ -151154,7 +151803,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -151234,10 +151883,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project_column: &749 + enterprise: *712 + installation: *713 + organization: *714 + project_column: &753 title: Project Column type: object properties: @@ -151276,7 +151925,7 @@ x-webhooks: - name - created_at - updated_at - repository: *711 + repository: *715 sender: *4 required: - action @@ -151355,18 +152004,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -151456,11 +152105,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 + repository: *715 sender: *4 required: - action @@ -151540,11 +152189,11 @@ x-webhooks: type: string enum: - moved - enterprise: *708 - installation: *709 - organization: *710 - project_column: *749 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project_column: *753 + repository: *715 sender: *4 required: - action @@ -151624,11 +152273,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151708,18 +152357,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - project: *750 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *741 - required: *742 + properties: *745 + required: *746 nullable: true sender: *4 required: @@ -151821,11 +152470,11 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151904,11 +152553,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 - organization: *710 - project: *750 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + project: *754 + repository: *715 sender: *4 required: - action @@ -151989,9 +152638,9 @@ x-webhooks: type: string enum: - closed - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152072,9 +152721,9 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152155,9 +152804,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152274,9 +152923,9 @@ x-webhooks: type: string to: type: string - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -152359,7 +153008,7 @@ x-webhooks: type: string enum: - archived - changes: &754 + changes: &758 type: object properties: archived_at: @@ -152373,9 +153022,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *709 - organization: *710 - projects_v2_item: &751 + installation: *713 + organization: *714 + projects_v2_item: &755 title: Projects v2 Item description: An item belonging to a project type: object @@ -152393,7 +153042,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *253 + content_type: *259 creator: *4 created_at: type: string @@ -152510,9 +153159,9 @@ x-webhooks: nullable: true to: type: string - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152594,9 +153243,9 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152677,9 +153326,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152785,7 +153434,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &752 + - &756 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -152807,7 +153456,7 @@ x-webhooks: required: - id - name - - &753 + - &757 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -152841,8 +153490,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *752 - - *753 + - *756 + - *757 required: - field_value - type: object @@ -152858,9 +153507,9 @@ x-webhooks: nullable: true required: - body - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -152955,9 +153604,9 @@ x-webhooks: to: type: string nullable: true - installation: *709 - organization: *710 - projects_v2_item: *751 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -153040,10 +153689,10 @@ x-webhooks: type: string enum: - restored - changes: *754 - installation: *709 - organization: *710 - projects_v2_item: *751 + changes: *758 + installation: *713 + organization: *714 + projects_v2_item: *755 sender: *4 required: - action @@ -153125,9 +153774,9 @@ x-webhooks: type: string enum: - reopened - installation: *709 - organization: *710 - projects_v2: *245 + installation: *713 + organization: *714 + projects_v2: *251 sender: *4 required: - action @@ -153208,14 +153857,14 @@ x-webhooks: type: string enum: - created - installation: *709 - organization: *710 - projects_v2_status_update: &757 + installation: *713 + organization: *714 + projects_v2_status_update: &761 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *755 - required: *756 + properties: *759 + required: *760 sender: *4 required: - action @@ -153296,9 +153945,9 @@ x-webhooks: type: string enum: - deleted - installation: *709 - organization: *710 - projects_v2_status_update: *757 + installation: *713 + organization: *714 + projects_v2_status_update: *761 sender: *4 required: - action @@ -153434,9 +154083,9 @@ x-webhooks: type: string format: date nullable: true - installation: *709 - organization: *710 - projects_v2_status_update: *757 + installation: *713 + organization: *714 + projects_v2_status_update: *761 sender: *4 required: - action @@ -153507,10 +154156,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - repository @@ -153587,13 +154236,13 @@ x-webhooks: type: string enum: - assigned - assignee: *728 - enterprise: *708 - installation: *709 - number: &758 + assignee: *732 + enterprise: *712 + installation: *713 + number: &762 description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -155876,7 +156525,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -155958,11 +156607,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -158240,7 +158889,7 @@ x-webhooks: - draft reason: type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -158322,11 +158971,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -160604,7 +161253,7 @@ x-webhooks: - draft reason: type: string - repository: *711 + repository: *715 sender: *4 required: - action @@ -160686,13 +161335,13 @@ x-webhooks: type: string enum: - closed - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: &759 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: &763 allOf: - - *571 + - *568 - type: object properties: allow_auto_merge: @@ -160754,7 +161403,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *711 + repository: *715 sender: *4 required: - action @@ -160835,12 +161484,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -160920,11 +161569,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *708 - milestone: *555 - number: *758 - organization: *710 - pull_request: &760 + enterprise: *712 + milestone: *550 + number: *762 + organization: *714 + pull_request: &764 title: Pull Request type: object properties: @@ -163187,7 +163836,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -163266,11 +163915,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -165552,7 +166201,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *711 + repository: *715 sender: *4 required: - action @@ -165676,12 +166325,12 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -165761,11 +166410,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -168032,7 +168681,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -168112,11 +168761,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *708 - installation: *709 - label: *727 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + label: *731 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -170398,7 +171047,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -170479,10 +171128,10 @@ x-webhooks: type: string enum: - locked - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -172762,7 +173411,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -172842,12 +173491,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *708 - milestone: *555 - number: *758 - organization: *710 - pull_request: *760 - repository: *711 + enterprise: *712 + milestone: *550 + number: *762 + organization: *714 + pull_request: *764 + repository: *715 sender: *4 required: - action @@ -172926,12 +173575,12 @@ x-webhooks: type: string enum: - opened - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173012,12 +173661,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173097,12 +173746,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *708 - installation: *709 - number: *758 - organization: *710 - pull_request: *759 - repository: *711 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 + pull_request: *763 + repository: *715 sender: *4 required: - action @@ -173468,9 +174117,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -175640,7 +176289,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -175720,7 +176369,7 @@ x-webhooks: type: string enum: - deleted - comment: &762 + comment: &766 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176005,9 +176654,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -178165,7 +178814,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -178245,11 +178894,11 @@ x-webhooks: type: string enum: - edited - changes: *761 - comment: *762 - enterprise: *708 - installation: *709 - organization: *710 + changes: *765 + comment: *766 + enterprise: *712 + installation: *713 + organization: *714 pull_request: type: object properties: @@ -180410,7 +181059,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *711 + repository: *715 sender: *4 required: - action @@ -180491,9 +181140,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -182666,7 +183315,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 review: description: The review that was affected. type: object @@ -182913,9 +183562,9 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -184969,8 +185618,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 - review: &763 + repository: *715 + review: &767 description: The review that was affected. type: object properties: @@ -185203,12 +185852,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -187491,7 +188140,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_reviewer: title: User type: object @@ -187575,12 +188224,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -189870,7 +190519,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190062,12 +190711,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -192352,7 +193001,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_reviewer: title: User type: object @@ -192437,12 +193086,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *708 - installation: *709 + enterprise: *712 + installation: *713 number: description: The pull request number. type: integer - organization: *710 + organization: *714 pull_request: title: Pull Request type: object @@ -194718,7 +195367,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194899,9 +195548,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -197076,8 +197725,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 - review: *763 + repository: *715 + review: *767 sender: *4 required: - action @@ -197157,9 +197806,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -199229,7 +199878,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 sender: *4 thread: type: object @@ -199616,9 +200265,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 pull_request: title: Simple Pull Request type: object @@ -201674,7 +202323,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *711 + repository: *715 sender: *4 thread: type: object @@ -202064,10 +202713,10 @@ x-webhooks: type: string before: type: string - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -204338,7 +204987,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -204420,11 +205069,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *764 - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + assignee: *768 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -206707,7 +207356,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -206786,11 +207435,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *708 - installation: *709 - label: *727 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + label: *731 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -209063,7 +209712,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -209144,10 +209793,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *708 - installation: *709 - number: *758 - organization: *710 + enterprise: *712 + installation: *713 + number: *762 + organization: *714 pull_request: title: Pull Request type: object @@ -211412,7 +212061,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *711 + repository: *715 sender: *4 required: - action @@ -211612,7 +212261,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *708 + enterprise: *712 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -211704,8 +212353,8 @@ x-webhooks: - url - author - committer - installation: *709 - organization: *710 + installation: *713 + organization: *714 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212280,9 +212929,9 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 registry_package: type: object properties: @@ -212728,7 +213377,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *745 + items: *749 summary: type: string tag_name: @@ -212782,7 +213431,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -212860,9 +213509,9 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 registry_package: type: object properties: @@ -213170,7 +213819,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *745 + items: *749 summary: type: string tag_name: @@ -213219,7 +213868,7 @@ x-webhooks: - owner - package_version - registry - repository: *711 + repository: *715 sender: *4 required: - action @@ -213296,10 +213945,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - release: &765 + enterprise: *712 + installation: *713 + organization: *714 + release: &769 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213617,7 +214266,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *711 + repository: *715 sender: *4 required: - action @@ -213694,11 +214343,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -213815,11 +214464,11 @@ x-webhooks: type: boolean required: - to - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -213897,9 +214546,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214221,7 +214870,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *711 + repository: *715 sender: *4 required: - action @@ -214297,10 +214946,10 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - release: &766 + enterprise: *712 + installation: *713 + organization: *714 + release: &770 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214619,7 +215268,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *711 + repository: *715 sender: *4 required: - action @@ -214695,11 +215344,11 @@ x-webhooks: type: string enum: - released - enterprise: *708 - installation: *709 - organization: *710 - release: *765 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *769 + repository: *715 sender: *4 required: - action @@ -214775,11 +215424,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *708 - installation: *709 - organization: *710 - release: *766 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + release: *770 + repository: *715 sender: *4 required: - action @@ -214855,11 +215504,11 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_advisory: *627 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_advisory: *632 sender: *4 required: - action @@ -214935,11 +215584,11 @@ x-webhooks: type: string enum: - reported - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_advisory: *627 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_advisory: *632 sender: *4 required: - action @@ -215015,10 +215664,10 @@ x-webhooks: type: string enum: - archived - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215095,10 +215744,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215176,10 +215825,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215263,10 +215912,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215378,10 +216027,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215453,10 +216102,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 status: type: string @@ -215537,10 +216186,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215617,10 +216266,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215714,10 +216363,10 @@ x-webhooks: - name required: - repository - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -215797,11 +216446,11 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 sender: *4 required: - action @@ -215879,11 +216528,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 sender: *4 required: - action @@ -215961,11 +216610,11 @@ x-webhooks: type: string enum: - edited - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - repository_ruleset: *291 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + repository_ruleset: *296 changes: type: object properties: @@ -215984,16 +216633,16 @@ x-webhooks: properties: added: type: array - items: *266 + items: *271 deleted: type: array - items: *266 + items: *271 updated: type: array items: type: object properties: - condition: *266 + condition: *271 changes: type: object properties: @@ -216026,16 +216675,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *589 deleted: type: array - items: *592 + items: *589 updated: type: array items: type: object properties: - rule: *592 + rule: *589 changes: type: object properties: @@ -216269,10 +216918,10 @@ x-webhooks: - from required: - owner - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216350,10 +216999,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216431,7 +217080,7 @@ x-webhooks: type: string enum: - create - alert: &767 + alert: &771 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216552,10 +217201,10 @@ x-webhooks: type: string enum: - open - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216761,10 +217410,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -216842,11 +217491,11 @@ x-webhooks: type: string enum: - reopen - alert: *767 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *771 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217045,10 +217694,10 @@ x-webhooks: enum: - fixed - open - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217126,11 +217775,11 @@ x-webhooks: type: string enum: - created - alert: &768 + alert: &772 type: object properties: - number: *54 - created_at: *55 + number: *158 + created_at: *159 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217138,8 +217787,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *56 - html_url: *57 + url: *161 + html_url: *162 locations_url: type: string format: uri @@ -217244,10 +217893,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217328,11 +217977,11 @@ x-webhooks: type: string enum: - created - alert: *768 - installation: *709 - location: *769 - organization: *710 - repository: *711 + alert: *772 + installation: *713 + location: *773 + organization: *714 + repository: *715 sender: *4 required: - location @@ -217570,11 +218219,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217652,11 +218301,11 @@ x-webhooks: type: string enum: - reopened - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217734,11 +218383,11 @@ x-webhooks: type: string enum: - resolved - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217816,11 +218465,11 @@ x-webhooks: type: string enum: - validated - alert: *768 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + alert: *772 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -217946,10 +218595,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *711 - enterprise: *708 - installation: *709 - organization: *710 + repository: *715 + enterprise: *712 + installation: *713 + organization: *714 sender: *4 required: - action @@ -218027,11 +218676,11 @@ x-webhooks: type: string enum: - published - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - security_advisory: &770 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + security_advisory: &774 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218214,11 +218863,11 @@ x-webhooks: type: string enum: - updated - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 - security_advisory: *770 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 + security_advisory: *774 sender: *4 required: - action @@ -218291,10 +218940,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218478,11 +219127,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *265 - enterprise: *708 - installation: *709 - organization: *710 - repository: *338 + security_and_analysis: *270 + enterprise: *712 + installation: *713 + organization: *714 + repository: *333 sender: *4 required: - changes @@ -218560,12 +219209,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: &771 + sponsorship: &775 type: object properties: created_at: @@ -218866,12 +219515,12 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - sponsorship @@ -218959,12 +219608,12 @@ x-webhooks: type: string required: - from - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219041,17 +219690,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &772 + effective_date: &776 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - sponsorship @@ -219125,7 +219774,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &773 + changes: &777 type: object properties: tier: @@ -219169,13 +219818,13 @@ x-webhooks: - from required: - tier - effective_date: *772 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + effective_date: *776 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219252,13 +219901,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *773 - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + changes: *777 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - sponsorship: *771 + sponsorship: *775 required: - action - changes @@ -219332,10 +219981,10 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219418,10 +220067,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219841,15 +220490,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *708 + enterprise: *712 id: description: The unique identifier of the status. type: integer - installation: *709 + installation: *713 name: type: string - organization: *710 - repository: *711 + organization: *714 + repository: *715 sender: *4 sha: description: The Commit SHA. @@ -219958,15 +220607,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - parent_issue_repo: *67 + parent_issue: *70 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - installation: *709 - organization: *710 - repository: *711 + sub_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220050,15 +220699,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - parent_issue_repo: *67 + parent_issue: *70 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - installation: *709 - organization: *710 - repository: *711 + sub_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220142,15 +220791,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - sub_issue_repo: *67 + sub_issue: *70 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - installation: *709 - organization: *710 - repository: *711 + parent_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220234,15 +220883,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *71 - sub_issue_repo: *67 + sub_issue: *70 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *71 - installation: *709 - organization: *710 - repository: *711 + parent_issue: *70 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -220319,12 +220968,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - team: &774 + team: &778 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220547,9 +221196,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -221007,7 +221656,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -221083,9 +221732,9 @@ x-webhooks: type: string enum: - created - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -221543,7 +222192,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -221620,9 +222269,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -222080,7 +222729,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -222224,9 +222873,9 @@ x-webhooks: - from required: - permissions - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -222684,7 +223333,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - changes @@ -222762,9 +223411,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *708 - installation: *709 - organization: *710 + enterprise: *712 + installation: *713 + organization: *714 repository: title: Repository description: A git repository @@ -223222,7 +223871,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *774 + team: *778 required: - action - team @@ -223298,10 +223947,10 @@ x-webhooks: type: string enum: - started - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 required: - action @@ -223374,16 +224023,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *708 + enterprise: *712 inputs: type: object nullable: true additionalProperties: true - installation: *709 - organization: *710 + installation: *713 + organization: *714 ref: type: string - repository: *711 + repository: *715 sender: *4 workflow: type: string @@ -223465,10 +224114,10 @@ x-webhooks: type: string enum: - completed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: allOf: @@ -223705,7 +224354,7 @@ x-webhooks: type: string required: - conclusion - deployment: *488 + deployment: *483 required: - action - repository @@ -223784,10 +224433,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: allOf: @@ -224047,7 +224696,7 @@ x-webhooks: required: - status - steps - deployment: *488 + deployment: *483 required: - action - repository @@ -224126,10 +224775,10 @@ x-webhooks: type: string enum: - queued - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: type: object @@ -224264,7 +224913,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *488 + deployment: *483 required: - action - repository @@ -224343,10 +224992,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 workflow_job: type: object @@ -224482,7 +225131,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *488 + deployment: *483 required: - action - repository @@ -224562,12 +225211,12 @@ x-webhooks: type: string enum: - completed - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object @@ -225566,12 +226215,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object @@ -226555,12 +227204,12 @@ x-webhooks: type: string enum: - requested - enterprise: *708 - installation: *709 - organization: *710 - repository: *711 + enterprise: *712 + installation: *713 + organization: *714 + repository: *715 sender: *4 - workflow: *723 + workflow: *727 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index c2fc1bc49..3f38c5702 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -188,6 +188,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -4898,6 +4902,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -5096,6 +5108,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -5858,6 +5879,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6056,6 +6085,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -6672,6 +6710,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6870,6 +6916,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -7117,6 +7172,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -7315,6 +7378,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -9117,6 +9189,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -9315,6 +9395,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -10128,6 +10217,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -10326,6 +10423,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -11056,6 +11162,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11254,6 +11368,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -11695,6 +11818,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11893,6 +12024,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -17348,6 +17488,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -17451,6 +17596,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -17591,6 +17740,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -17611,6 +17765,11 @@ "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean", "default": false + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -17690,6 +17849,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -17793,6 +17957,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -17848,17 +18016,17 @@ } } }, - "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-enterprise", + "summary": "List custom images for an enterprise", + "description": "List custom images for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" }, "parameters": [ { @@ -17889,46 +18057,60 @@ "images": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "type": "integer", + "example": 1 }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, - "size_gb": { - "description": "Image size in GB.", + "total_versions_size": { + "description": "Total size of all the image versions in GB.", "type": "integer", - "example": 86 + "example": 200 }, - "display_name": { + "name": { "description": "Display name for this image.", "type": "string", - "example": 20.04 + "example": "CustomImage" }, "source": { "description": "The image provider.", "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" } }, "required": [ "id", "platform", - "size_gb", - "display_name", - "source" + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" ] } } @@ -17937,11 +18119,141 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get an enterprise custom image definition for GitHub Actions Hosted Runners", + "description": "Get an enterprise custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" } } } @@ -17955,21 +18267,73 @@ "category": "actions", "subcategory": "hosted-runners" } + }, + "delete": { + "summary": "Delete a custom image from the enterprise", + "description": "Delete a custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } } }, - "/enterprises/{enterprise}/actions/hosted-runners/images/partner": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { "get": { - "summary": "Get partner images for GitHub-hosted runners in an enterprise", - "description": "Get the list of partner images available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-partner-images-for-enterprise", + "summary": "List image versions of a custom image for an enterprise", + "description": "List image versions of a custom image for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-image-versions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" }, "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "enterprise", "description": "The slug version of the enterprise name.", @@ -17989,55 +18353,51 @@ "type": "object", "required": [ "total_count", - "images" + "image_versions" ], "properties": { "total_count": { "type": "integer" }, - "images": { + "image_versions": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "version": { + "description": "The version of image.", "type": "string", - "example": "ubuntu-20.04" + "example": "1.0.0" }, - "platform": { - "description": "The operating system of the image.", + "state": { + "description": "The state of image version.", "type": "string", - "example": "linux-x64" + "example": "Ready" }, "size_gb": { - "description": "Image size in GB.", + "description": "Image version size in GB.", "type": "integer", - "example": 86 + "example": 30 }, - "display_name": { - "description": "Display name for this image.", + "created_on": { + "description": "The creation date time of the image version.", "type": "string", - "example": 20.04 + "example": "2024-11-09T23:39:01Z" }, - "source": { - "description": "The image provider.", + "state_details": { + "description": "The image version status details.", "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "example": "None" } }, "required": [ - "id", - "platform", + "version", + "state", "size_gb", - "display_name", - "source" + "created_on", + "state_details" ] } } @@ -18046,11 +18406,21 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] } } } @@ -18066,17 +18436,17 @@ } } }, - "/enterprises/{enterprise}/actions/hosted-runners/limits": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { "get": { - "summary": "Get limits on GitHub-hosted runners for an enterprise", - "description": "Get the GitHub-hosted runners limits for an enterprise.", + "summary": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runners-limits-for-enterprise", + "operationId": "actions/get-custom-image-version-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -18087,6 +18457,25 @@ "schema": { "type": "string" } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } } ], "responses": { @@ -18095,41 +18484,51 @@ "content": { "application/json": { "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" } }, "required": [ - "public_ips" + "version", + "state", + "size_gb", + "created_on", + "state_details" ] }, "examples": { "default": { "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" } } } @@ -18143,19 +18542,369 @@ "category": "actions", "subcategory": "hosted-runners" } + }, + "delete": { + "summary": "Delete an image version of custom image from the enterprise", + "description": "Delete an image version of custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } } }, - "/enterprises/{enterprise}/actions/hosted-runners/machine-sizes": { + "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { "get": { - "summary": "Get GitHub-hosted runners machine specs for an enterprise", - "description": "Get the list of machine specs available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-machine-specs-for-enterprise", + "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-enterprise", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an enterprise", + "description": "Get the list of partner images available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-partner-images-for-enterprise", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an enterprise", + "description": "Get the GitHub-hosted runners limits for an enterprise.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runners-limits-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an enterprise", + "description": "Get the list of machine specs available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-machine-specs-for-enterprise", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" }, "parameters": [ { @@ -18397,6 +19146,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -18500,6 +19254,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -18615,6 +19373,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -18684,6 +19447,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -18787,6 +19555,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -18925,6 +19697,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -19028,6 +19805,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -26604,6 +27385,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -26802,6 +27591,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -27359,6 +28157,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -27557,6 +28363,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -28270,6 +29085,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -28468,6 +29291,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -29572,6 +30404,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -29770,6 +30610,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -41054,6 +41903,654 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": { + "get": { + "summary": "Get Copilot enterprise usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": { + "get": { + "summary": "Get Copilot enterprise usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -41195,29 +42692,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -44440,17 +45914,17 @@ } } }, - "/enterprises/{enterprise}/properties/schema": { + "/enterprises/{enterprise}/org-properties/schema": { "get": { - "summary": "Get custom properties for an enterprise", - "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "summary": "Get organization custom properties schema for an enterprise", + "description": "Gets all organization custom property definitions that are defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", "tags": [ "enterprise-admin" ], - "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" }, "parameters": [ { @@ -44471,121 +45945,132 @@ "schema": { "type": "array", "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "example": "organization" - }, - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { "type": "array", "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" + } }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": "string", - "nullable": true, - "enum": [ - "org_actors", - "org_and_repo_actors" - ], - "example": "org_actors", - "description": "Who can edit the values of the property" + "required": [ + "property_name", + "value_type" + ] } - }, - "required": [ - "property_name", - "value_type" ] } }, "examples": { "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } } } } @@ -44648,19 +46133,19 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "custom-properties-for-orgs" } }, "patch": { - "summary": "Create or update custom properties for an enterprise", - "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "summary": "Create or update organization custom property definitions on an enterprise", + "description": "Creates new or updates existing organization custom properties defined on an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", "tags": [ "enterprise-admin" ], - "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" }, "parameters": [ { @@ -44682,89 +46167,1801 @@ "properties": { "properties": { "type": "array", - "description": "The array of custom properties to create or update.", + "description": "The array of organization custom properties to create or update.", "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "example": "organization" - }, - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { "type": "array", "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" + } }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": "string", - "nullable": true, - "enum": [ - "org_actors", - "org_and_repo_actors" - ], - "example": "org_actors", - "description": "Who can edit the values of the property" + "required": [ + "property_name", + "value_type" + ] } - }, - "required": [ - "property_name", - "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + } + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": { + "get": { + "summary": "Get an organization custom property definition from an enterprise", + "description": "Gets an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "put": { + "summary": "Create or update an organization custom property definition on an enterprise", + "description": "Creates a new or updates an existing organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property Payload", + "description": "Payload for creating or updating an organization custom property definition on an enterprise.", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property." + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property." + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property." + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property." + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "delete": { + "summary": "Remove an organization custom property definition from an enterprise", + "description": "Removes an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/values": { + "get": { + "summary": "List custom property values for organizations in an enterprise", + "description": "Lists enterprise organizations with all of their custom property values.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Enterprise Organization Custom Property Values", + "description": "List of custom property values for an organization", + "type": "object", + "properties": { + "organization_id": { + "type": "integer", + "example": 1296269 + }, + "organization_login": { + "type": "string", + "example": "Hello-World" + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "organization_id", + "organization_login", + "properties" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "organization_id": 1296269, + "organization_login": "Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for organizations in an enterprise", + "description": "Create or update custom property values for organizations in an enterprise.\n\nTo remove a custom property value from an organization, set the property value to `null`.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"edit enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization_logins": { + "type": "array", + "description": "The names of organizations that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the organizations.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "organization_logins", + "properties" + ] + }, + "examples": { + "default": { + "value": { + "organization_logins": [ + "acme", + "github" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/properties/schema": { + "get": { + "summary": "Get custom properties for an enterprise", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an enterprise", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" ] }, "minItems": 1, @@ -45988,72 +49185,406 @@ }, { "type": "object", - "title": "organization_name_and_repository_property", - "description": "Conditions to target organizations by name and repositories by property", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", "allOf": [ { - "title": "Repository ruleset conditions for organization names", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization name condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_name": { + "organization_property": { "type": "object", "properties": { "include": { "type": "array", - "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - }, - "required": [ - "organization_name" - ] - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { "title": "Repository ruleset property targeting definition", "type": "object", - "description": "Parameters for a targeting a repository property", + "description": "Parameters for a targeting a organization property", "properties": { "name": { "type": "string", - "description": "The name of the repository property to target" + "description": "The name of the organization property to target" }, "property_values": { "type": "array", - "description": "The values to match for the repository property", + "description": "The values to match for the organization property", "items": { "type": "string" } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] } }, "required": [ @@ -46064,30 +49595,22 @@ }, "exclude": { "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", "items": { "title": "Repository ruleset property targeting definition", "type": "object", - "description": "Parameters for a targeting a repository property", + "description": "Parameters for a targeting a organization property", "properties": { "name": { "type": "string", - "description": "The name of the repository property to target" + "description": "The name of the organization property to target" }, "property_values": { "type": "array", - "description": "The values to match for the repository property", + "description": "The values to match for the organization property", "items": { "type": "string" } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] } }, "required": [ @@ -46100,62 +49623,7 @@ } }, "required": [ - "repository_property" - ] - }, - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - { - "type": "object", - "title": "organization_id_and_repository_name", - "description": "Conditions to target organizations by id and all repositories", - "allOf": [ - { - "title": "Repository ruleset conditions for organization IDs", - "type": "object", - "description": "Parameters for an organization ID condition", - "properties": { - "organization_id": { - "type": "object", - "properties": { - "organization_ids": { - "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "organization_id" + "organization_property" ] }, { @@ -46221,29 +49689,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_property", - "description": "Conditions to target organization by id and repositories by property", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -50147,36 +53660,262 @@ }, { "type": "object", - "title": "organization_name_and_repository_property", - "description": "Conditions to target organizations by name and repositories by property", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization names", + "title": "Repository ruleset conditions for organization IDs", "type": "object", - "description": "Parameters for an organization name condition", + "description": "Parameters for an organization ID condition", "properties": { - "organization_name": { + "organization_id": { "type": "object", "properties": { - "include": { - "type": "array", - "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", - "items": { - "type": "string" - } - }, - "exclude": { + "organization_ids": { "type": "array", - "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", "items": { - "type": "string" + "type": "integer" } } } } }, "required": [ - "organization_name" + "organization_id" ] }, { @@ -50292,29 +54031,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_name", - "description": "Conditions to target organizations by id and all repositories", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -50380,29 +54164,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_property", - "description": "Conditions to target organization by id and repositories by property", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -54907,7 +58736,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -55891,6 +59720,19 @@ "schema": { "type": "string" } + }, + { + "name": "state", + "in": "query", + "description": "Set to `active` or `deleted` to only list cost centers in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ] + } } ], "responses": { @@ -57751,7 +61593,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -57934,7 +61776,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -57942,7 +61784,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -57950,7 +61792,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -59434,6 +63276,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -60748,6 +64600,772 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -60976,6 +65594,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -100929,10 +105557,377 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + }, + "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": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "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", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -101076,7 +106071,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -101084,7 +106079,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -101092,7 +106087,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -103312,6 +108307,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -103415,6 +108415,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -103555,6 +108559,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -103573,6 +108582,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -103653,6 +108667,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -103756,6 +108775,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -103811,6 +108834,587 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, + "examples": { + "default": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -104360,6 +109964,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -104463,6 +110072,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -104578,6 +110191,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -104647,6 +110265,261 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -104750,247 +110623,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "example": true - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -110468,6 +116104,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -110571,6 +116212,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -119821,6 +125466,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -122588,7 +128337,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -122599,8 +128349,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -140169,29 +145930,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -158973,6 +164711,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -159171,6 +164917,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -159948,6 +165703,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -160146,6 +165909,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -191028,16 +196800,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -198192,16 +203970,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -352339,16 +358123,6 @@ "default": "desc" } }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -352376,29 +358150,6 @@ "schema": { "type": "string" } - }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "responses": { @@ -390802,6 +396553,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -391000,6 +396759,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -539565,7 +545333,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -618368,6 +624136,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -618566,6 +624342,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -678605,6 +684390,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -678803,6 +684596,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -685532,16 +691334,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -692669,16 +698477,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -716702,7 +722516,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -716833,7 +722647,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -716841,7 +722655,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -716849,7 +722663,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -891633,6 +897447,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -891831,6 +897653,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -894200,6 +900031,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -894398,6 +900237,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -896674,6 +902522,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -896872,6 +902728,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -899148,6 +905013,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -899346,6 +905219,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -901754,6 +907636,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -901952,6 +907842,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -904367,6 +910266,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -904565,6 +910472,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -908603,6 +914519,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -908801,6 +914725,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -1048250,6 +1054183,1600 @@ } } }, + "organization-custom-property-created": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "A new organization custom property was created.", + "operationId": "organization-custom-property/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "definition": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was deleted.", + "operationId": "organization-custom-property/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "definition": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property that was deleted." + } + }, + "required": [ + "property_name" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-updated": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was updated.", + "operationId": "organization-custom-property/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "definition": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-values-updated": { + "post": { + "summary": "This event occurs when there is activity relating to custom property values for an organization.", + "description": "The custom property values of an organization were updated.", + "operationId": "organization-custom-property-values/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom property values updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "new_property_values": { + "type": "array", + "description": "The new custom property values.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "old_property_values": { + "type": "array", + "description": "The old custom property values.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "action", + "organization", + "enterprise", + "new_property_values", + "old_property_values" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization-custom-property-values", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b2f4ab095..461b32bd5 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -99,6 +99,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -446,7 +448,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &99 + - &104 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -455,7 +457,7 @@ paths: required: false schema: type: string - - &100 + - &105 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -464,7 +466,7 @@ paths: required: false schema: type: string - - &101 + - &106 name: direction description: The direction to sort the results by. in: query @@ -685,7 +687,7 @@ paths: required: - vector_string - score - cvss_severities: &115 + cvss_severities: &125 type: object nullable: true properties: @@ -725,7 +727,7 @@ paths: required: - vector_string - score - epss: &116 + epss: &126 type: object nullable: true readOnly: true @@ -863,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &412 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -996,7 +998,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &233 + schema: &251 title: Validation Error Simple description: Validation Error Simple type: object @@ -1029,7 +1031,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &737 + - &756 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1147,7 +1149,7 @@ paths: GitHub. type: object nullable: true - properties: &186 + properties: &203 id: description: Unique identifier of the GitHub app example: 37 @@ -1280,7 +1282,7 @@ paths: about itself. example: 5 type: integer - required: &187 + required: &204 - id - node_id - owner @@ -1585,7 +1587,7 @@ paths: schema: type: integer default: 30 - - &320 + - &338 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1601,7 +1603,7 @@ paths: application/json: schema: type: array - items: &321 + items: &339 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1681,7 +1683,7 @@ paths: - installation_id - repository_id examples: - default: &322 + default: &340 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1713,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &747 + schema: &766 title: Scim Error description: Scim Error type: object @@ -1740,7 +1742,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &232 + schema: &250 title: Validation Error description: Validation Error type: object @@ -1809,7 +1811,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &341 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1923,7 +1925,7 @@ paths: - request - response examples: - default: &324 + default: &342 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2124,7 +2126,7 @@ paths: parameters: - *17 - *19 - - &196 + - &213 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2369,6 +2371,14 @@ paths: token to update GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token to view and edit custom properties for an organization, + when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access @@ -2549,6 +2559,15 @@ paths: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token for organization custom properties management at + the enterprise level. + enum: + - read + - write + - admin enterprise_organization_installations: type: string description: The level of permission to grant the access @@ -2719,7 +2738,7 @@ paths: application/json: schema: *22 examples: - default: &79 + default: &84 value: id: 1 account: @@ -2869,11 +2888,11 @@ paths: - selected repositories: type: array - items: &69 + items: &74 title: Repository description: A repository on GitHub. type: object - properties: &390 + properties: &407 id: description: Unique identifier of the repository example: 42 @@ -2893,7 +2912,7 @@ paths: title: License Simple description: License Simple type: object - properties: &192 + properties: &209 key: type: string example: mit @@ -2915,7 +2934,7 @@ paths: html_url: type: string format: uri - required: &193 + required: &210 - key - name - url @@ -3311,7 +3330,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &391 + required: &408 - archive_url - assignees_url - blobs_url @@ -7468,7 +7487,7 @@ paths: description: Response content: application/json: - schema: &234 + schema: &252 type: object properties: total_active_caches_count: @@ -7483,7 +7502,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &235 + default: &253 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7569,13 +7588,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + example: latest required: - id - size_gb - display_name - source nullable: true - machine_size_details: &47 + machine_size_details: &52 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7658,6 +7682,10 @@ paths: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -7667,7 +7695,7 @@ paths: - public_ip_enabled - platform examples: - default: &236 + default: &254 value: total_count: 2 runners: @@ -7756,6 +7784,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -7775,6 +7808,11 @@ paths: `GET actions/hosted-runners/limits` type: boolean default: false + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -7797,7 +7835,7 @@ paths: application/json: schema: *44 examples: - default: &48 + default: &53 value: id: 5 name: My hosted ubuntu runner @@ -7824,6 +7862,309 @@ paths: githubCloudOnly: true category: actions subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an enterprise + description: |- + List custom images for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &45 + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` + parameter when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the + image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &47 + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get an enterprise custom image definition for GitHub Actions Hosted + Runners + description: |- + Get an enterprise custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *41 + - &46 + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *45 + examples: + default: &255 + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the enterprise + description: |- + Delete a custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + parameters: + - *41 + - *46 + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an enterprise + description: |- + List image versions of a custom image for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + parameters: + - *46 + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: &48 + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image + version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *47 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of an enterprise custom image for GitHub Actions + Hosted Runners + description: |- + Get an image version of an enterprise custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + parameters: + - *41 + - *46 + - &49 + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: &256 + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the enterprise + description: |- + Delete an image version of custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + parameters: + - *41 + - *46 + - *49 + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an enterprise @@ -7852,7 +8193,7 @@ paths: type: integer images: type: array - items: &45 + items: &50 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -7888,7 +8229,7 @@ paths: - display_name - source examples: - default: &46 + default: &51 value: id: ubuntu-20.04 platform: linux-x64 @@ -7928,9 +8269,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -7953,7 +8294,7 @@ paths: description: Response content: application/json: - schema: &237 + schema: &257 type: object properties: public_ips: @@ -7978,7 +8319,7 @@ paths: required: - public_ips examples: - default: &238 + default: &258 value: public_ips: current_usage: 17 @@ -8016,9 +8357,9 @@ paths: type: integer machine_specs: type: array - items: *47 + items: *52 examples: - default: &239 + default: &259 value: id: 4-core cpu_cores: 4 @@ -8086,7 +8427,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - &49 + - &54 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8100,7 +8441,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 headers: Link: *43 x-github: @@ -8121,7 +8462,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *49 + - *54 requestBody: required: true content: @@ -8147,6 +8488,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -8161,7 +8507,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8178,7 +8524,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *49 + - *54 responses: '202': description: Response @@ -8186,7 +8532,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8254,7 +8600,7 @@ paths: schema: type: object properties: - enabled_organizations: &50 + enabled_organizations: &55 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8267,7 +8613,7 @@ paths: description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. - allowed_actions: &51 + allowed_actions: &56 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8275,12 +8621,12 @@ paths: - all - local_only - selected - selected_actions_url: &242 + selected_actions_url: &262 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &52 + sha_pinning_required: &57 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8322,9 +8668,9 @@ paths: schema: type: object properties: - enabled_organizations: *50 - allowed_actions: *51 - sha_pinning_required: *52 + enabled_organizations: *55 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled_organizations examples: @@ -8355,7 +8701,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &244 + schema: &264 type: object properties: days: @@ -8373,7 +8719,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &748 + '401': &767 description: Authorization failure '404': *6 x-github: @@ -8401,7 +8747,7 @@ paths: required: true content: application/json: - schema: &245 + schema: &265 type: object properties: days: @@ -8436,7 +8782,7 @@ paths: description: Response content: application/json: - schema: &53 + schema: &58 type: object properties: approval_policy: @@ -8450,7 +8796,7 @@ paths: required: - approval_policy examples: - default: &246 + default: &266 value: approval_policy: first_time_contributors '404': *6 @@ -8479,7 +8825,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -8508,7 +8854,7 @@ paths: description: Response content: application/json: - schema: &247 + schema: &267 type: object required: - run_workflows_from_fork_pull_requests @@ -8534,7 +8880,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &54 + default: &59 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8562,7 +8908,7 @@ paths: required: true content: application/json: - schema: &248 + schema: &268 type: object required: - run_workflows_from_fork_pull_requests @@ -8585,7 +8931,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -8625,11 +8971,11 @@ paths: type: number organizations: type: array - items: &64 + items: &69 title: Organization Simple description: A GitHub organization. type: object - properties: &111 + properties: &116 login: type: string example: github @@ -8670,7 +9016,7 @@ paths: type: string example: A great organization nullable: true - required: &112 + required: &117 - login - url - id @@ -8687,7 +9033,7 @@ paths: - total_count - organizations examples: - default: &65 + default: &70 value: total_count: 1 organizations: @@ -8766,7 +9112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &55 + - &60 name: org_id description: The unique identifier of the organization. in: path @@ -8795,7 +9141,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *55 + - *60 responses: '204': description: Response @@ -8824,7 +9170,7 @@ paths: description: Response content: application/json: - schema: &56 + schema: &61 type: object properties: github_owned_allowed: @@ -8845,7 +9191,7 @@ paths: items: type: string examples: - default: &57 + default: &62 value: github_owned_allowed: true verified_allowed: false @@ -8878,9 +9224,9 @@ paths: required: true content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8985,17 +9331,17 @@ paths: description: Success response content: application/json: - schema: &251 + schema: &271 type: object properties: - default_workflow_permissions: &58 + default_workflow_permissions: &63 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &59 + can_approve_pull_request_reviews: &64 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9003,7 +9349,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &60 + default: &65 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9033,13 +9379,13 @@ paths: required: true content: application/json: - schema: &252 + schema: &272 type: object properties: - default_workflow_permissions: *58 - can_approve_pull_request_reviews: *59 + default_workflow_permissions: *63 + can_approve_pull_request_reviews: *64 examples: - default: *60 + default: *65 responses: '204': description: Success response @@ -9084,7 +9430,7 @@ paths: type: number runner_groups: type: array - items: &61 + items: &66 type: object properties: id: @@ -9263,9 +9609,9 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: - default: &62 + default: &67 value: id: 2 name: octo-runner-group @@ -9300,7 +9646,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &63 + - &68 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9312,9 +9658,9 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: - default: *62 + default: *67 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9334,7 +9680,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: false content: @@ -9386,7 +9732,7 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: default: value: @@ -9422,7 +9768,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *63 + - *68 responses: '204': description: Response @@ -9446,7 +9792,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 + - *68 - *17 - *19 responses: @@ -9461,12 +9807,12 @@ paths: type: number organizations: type: array - items: *64 + items: *69 required: - total_count - organizations examples: - default: *65 + default: *70 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9486,7 +9832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: true content: @@ -9532,8 +9878,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 - - *55 + - *68 + - *60 responses: '204': description: Response @@ -9556,8 +9902,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 - - *55 + - *68 + - *60 responses: '204': description: Response @@ -9581,7 +9927,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *63 + - *68 - *17 - *19 responses: @@ -9596,7 +9942,7 @@ paths: type: number runners: type: array - items: &67 + items: &72 title: Self hosted runners description: A self hosted runner type: object @@ -9625,7 +9971,7 @@ paths: type: boolean labels: type: array - items: &71 + items: &76 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -9658,7 +10004,7 @@ paths: - total_count - runners examples: - default: &68 + default: &73 value: total_count: 2 runners: @@ -9718,7 +10064,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: true content: @@ -9763,8 +10109,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *63 - - &66 + - *68 + - &71 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -9793,8 +10139,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *63 - - *66 + - *68 + - *71 responses: '204': description: Response @@ -9837,9 +10183,9 @@ paths: type: number runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -9869,7 +10215,7 @@ paths: application/json: schema: type: array - items: &256 + items: &276 title: Runner Application description: Runner Application type: object @@ -9894,7 +10240,7 @@ paths: - download_url - filename examples: - default: &257 + default: &277 value: - os: osx architecture: x64 @@ -9978,7 +10324,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &258 + '201': &278 description: Response content: application/json: @@ -9988,7 +10334,7 @@ paths: - runner - encoded_jit_config properties: - runner: *67 + runner: *72 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10017,7 +10363,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &109 + '409': &114 description: Conflict content: application/json: @@ -10055,7 +10401,7 @@ paths: description: Response content: application/json: - schema: &70 + schema: &75 title: Authentication Token description: Authentication Token type: object @@ -10077,7 +10423,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *69 + items: *74 single_file: type: string example: config.yaml @@ -10093,7 +10439,7 @@ paths: - token - expires_at examples: - default: &259 + default: &279 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10131,9 +10477,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: &260 + default: &280 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10157,15 +10503,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: &261 + default: &281 value: id: 23 name: MBP @@ -10205,7 +10551,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *66 + - *71 responses: '204': description: Response @@ -10230,9 +10576,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: - '200': &72 + '200': &77 description: Response content: application/json: @@ -10246,7 +10592,7 @@ paths: type: integer labels: type: array - items: *71 + items: *76 examples: default: value: @@ -10284,7 +10630,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 requestBody: required: true content: @@ -10308,7 +10654,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10331,7 +10677,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 requestBody: required: true content: @@ -10356,7 +10702,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10379,9 +10725,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: - '200': &262 + '200': &282 description: Response content: application/json: @@ -10395,7 +10741,7 @@ paths: type: integer labels: type: array - items: *71 + items: *76 examples: default: value: @@ -10436,8 +10782,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 - - &263 + - *71 + - &283 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10445,7 +10791,7 @@ paths: schema: type: string responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10470,20 +10816,20 @@ paths: description: Response content: application/json: - schema: &77 + schema: &82 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &73 + announcement: &78 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &74 + expires_at: &79 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10493,7 +10839,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &75 + user_dismissible: &80 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10504,7 +10850,7 @@ paths: - expires_at - user_dismissible examples: - default: &76 + default: &81 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10528,18 +10874,18 @@ paths: required: true content: application/json: - schema: &270 + schema: &290 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *73 - expires_at: *74 - user_dismissible: *75 + announcement: *78 + expires_at: *79 + user_dismissible: *80 required: - announcement examples: - default: *76 + default: *81 parameters: - *41 responses: @@ -10547,9 +10893,9 @@ paths: description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -10645,7 +10991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &78 + - &83 name: org description: The organization name. The name is not case sensitive. in: path @@ -10662,7 +11008,7 @@ paths: application/json: schema: type: array - items: &80 + items: &85 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -10713,7 +11059,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 - *17 - *19 responses: @@ -10808,7 +11154,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 responses: '200': description: A GitHub App installation that was installed previously. @@ -10816,14 +11162,14 @@ paths: application/json: schema: *22 examples: - default: *79 + default: *84 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *79 + default: *84 requestBody: required: true content: @@ -10891,7 +11237,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 - *23 responses: '204': @@ -10919,7 +11265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *78 + - *83 - *23 - *17 - *19 @@ -10931,7 +11277,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -10960,7 +11306,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *78 + - *83 - *23 requestBody: required: true @@ -11000,7 +11346,7 @@ paths: application/json: schema: *22 examples: - default: *79 + default: *84 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11021,7 +11367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *78 + - *83 - *23 responses: '200': @@ -11031,7 +11377,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -11082,7 +11428,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *78 + - *83 - *23 responses: '200': @@ -11092,7 +11438,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -11169,7 +11515,7 @@ paths: required: false schema: type: string - - &271 + - &291 name: include description: |- The event types to include: @@ -11187,7 +11533,7 @@ paths: - web - git - all - - &272 + - &292 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -11195,7 +11541,7 @@ paths: required: false schema: type: string - - &273 + - &293 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -11203,7 +11549,7 @@ paths: required: false schema: type: string - - &274 + - &294 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11225,7 +11571,7 @@ paths: application/json: schema: type: array - items: &275 + items: &295 type: object properties: "@timestamp": @@ -11347,7 +11693,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &276 + default: &296 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11526,7 +11872,7 @@ paths: vendor_specific: type: object oneOf: - - &84 + - &89 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11545,7 +11891,7 @@ paths: - key_id - encrypted_sas_url - container - - &85 + - &90 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11564,7 +11910,7 @@ paths: - name - encrypted_connstring - key_id - - &86 + - &91 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11592,7 +11938,7 @@ paths: - bucket - key_id - region - - &87 + - &92 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11626,7 +11972,7 @@ paths: - encrypted_secret_key - key_id - region - - &88 + - &93 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -11654,7 +12000,7 @@ paths: - key_id - port - ssl_verify - - &89 + - &94 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -11686,7 +12032,7 @@ paths: - key_id - port - ssl_verify - - &90 + - &95 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -11704,7 +12050,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &91 + - &96 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -11735,7 +12081,7 @@ paths: - stream_type - vendor_specific examples: - default: &92 + default: &97 value: enabled: false stream_type: Azure Event Hubs @@ -11749,7 +12095,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &81 + schema: &86 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -11780,7 +12126,7 @@ paths: - created_at - updated_at examples: - default: &82 + default: &87 value: id: 1 stream_type: Splunk @@ -11809,7 +12155,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &83 + - &88 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -11821,9 +12167,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *81 + schema: *86 examples: - default: *82 + default: *87 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11843,7 +12189,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *83 + - *88 requestBody: required: true content: @@ -11869,28 +12215,28 @@ paths: vendor_specific: type: object oneOf: - - *84 - - *85 - - *86 - - *87 - - *88 - *89 - *90 - *91 + - *92 + - *93 + - *94 + - *95 + - *96 required: - enabled - stream_type - vendor_specific examples: - default: *92 + default: *97 responses: '200': description: Successful update content: application/json: - schema: *81 + schema: *86 examples: - default: *82 + default: *87 '422': description: Validation error content: @@ -11921,7 +12267,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *83 + - *88 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -11948,13 +12294,13 @@ paths: subcategory: bypass-requests parameters: - *41 - - &93 + - &98 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &94 + - &99 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -11962,7 +12308,7 @@ paths: required: false schema: type: string - - &95 + - &100 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -11970,7 +12316,7 @@ paths: required: false schema: type: string - - &96 + - &101 name: time_period description: |- The time period to filter by. @@ -11986,7 +12332,7 @@ paths: - week - month default: day - - &97 + - &102 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12013,7 +12359,7 @@ paths: application/json: schema: type: array - items: &277 + items: &297 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12130,7 +12476,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &98 + items: &103 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12174,7 +12520,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &278 + default: &298 value: - id: 21 number: 42 @@ -12265,11 +12611,11 @@ paths: subcategory: delegated-bypass parameters: - *41 - - *93 - - *94 - - *95 - - *96 - - *97 + - *98 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -12279,7 +12625,7 @@ paths: application/json: schema: type: array - items: &280 + items: &300 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12393,7 +12739,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *98 + items: *103 url: type: string format: uri @@ -12404,7 +12750,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &281 + default: &301 value: - id: 21 number: 42 @@ -12489,17 +12835,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &286 + - &306 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &102 + schema: &107 type: string description: The name of the tool used to generate the code scanning analysis. - - &287 + - &307 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -12507,22 +12853,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &103 + schema: &108 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *99 - - *100 + - *104 + - *105 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &288 + schema: &308 type: string description: State of a code scanning alert. enum: @@ -12547,42 +12893,42 @@ paths: application/json: schema: type: array - items: &289 + items: &309 type: object properties: - number: &113 + number: &123 type: integer description: The security alert number. readOnly: true - created_at: &120 + created_at: &130 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &121 + updated_at: &131 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - url: &118 + url: &128 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &119 + html_url: &129 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &526 + instances_url: &543 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &104 + state: &109 type: string description: State of a code scanning alert. nullable: true @@ -12590,7 +12936,7 @@ paths: - open - dismissed - fixed - fixed_at: &123 + fixed_at: &133 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12604,14 +12950,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &122 + dismissed_at: &132 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &527 + dismissed_reason: &544 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12620,13 +12966,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &528 + dismissed_comment: &545 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &529 + rule: &546 type: object properties: id: @@ -12679,25 +13025,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &530 + tool: &547 type: object properties: - name: *102 + name: *107 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *103 - most_recent_instance: &531 + guid: *108 + most_recent_instance: &548 type: object properties: - ref: &524 + ref: &541 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &541 + analysis_key: &558 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -12708,13 +13054,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &542 + category: &559 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *104 + state: *109 commit_sha: type: string message: @@ -12753,11 +13099,11 @@ paths: - generated - test - library - repository: &110 + repository: &115 title: Simple Repository description: A GitHub repository. type: object - properties: &220 + properties: &238 id: type: integer format: int64 @@ -12984,7 +13330,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &221 + required: &239 - archive_url - assignees_url - blobs_url @@ -13056,7 +13402,7 @@ paths: - most_recent_instance - repository examples: - default: &290 + default: &310 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13287,7 +13633,7 @@ paths: headers: Link: *43 '404': *6 - '503': &167 + '503': &183 description: Service unavailable content: application/json: @@ -13331,8 +13677,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -13340,7 +13686,7 @@ paths: application/json: schema: type: array - items: &105 + items: &110 type: object description: A code security configuration properties: @@ -13709,7 +14055,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &291 + code_scanning_options: &311 type: object description: Security Configuration feature options for code scanning nullable: true @@ -13726,7 +14072,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &108 + code_scanning_default_setup_options: &113 type: object description: Feature options for code scanning default setup nullable: true @@ -13843,9 +14189,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *105 + schema: *110 examples: - default: &106 + default: &111 value: id: 1325 target_type: enterprise @@ -13903,7 +14249,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &313 type: array description: A list of default code security configurations items: @@ -13917,9 +14263,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *105 + configuration: *110 examples: - default: &294 + default: &314 value: - default_for_new_repos: public configuration: @@ -14008,7 +14354,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &107 + - &112 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14020,9 +14366,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *106 + default: *111 '304': *37 '403': *29 '404': *6 @@ -14047,7 +14393,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14126,7 +14472,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14214,13 +14560,13 @@ paths: description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *106 + default: *111 '304': *37 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14244,14 +14590,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *107 + - *112 responses: - '204': &133 + '204': &143 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14276,7 +14622,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14303,7 +14649,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14328,7 +14674,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14368,12 +14714,12 @@ paths: - none - private_and_internal - public - configuration: *105 + configuration: *110 examples: default: value: default_for_new_repos: all - configuration: &292 + configuration: &312 value: id: 1325 target_type: organization @@ -14430,7 +14776,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *107 + - *112 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -14439,8 +14785,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14458,7 +14804,7 @@ paths: application/json: schema: type: array - items: &295 + items: &315 type: object description: Repositories associated with a code security configuration and attachment status @@ -14476,13 +14822,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *110 + repository: *115 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &296 + repository: &316 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -14947,7 +15293,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &124 + items: &134 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -14964,14 +15310,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *111 - required: *112 + properties: *116 + required: *117 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &282 + - &302 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15046,7 +15392,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &355 + properties: &373 id: description: Unique identifier of the team type: integer @@ -15118,7 +15464,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &356 + required: &374 - id - node_id - url @@ -15144,7 +15490,7 @@ paths: - slug - parent - type - - &178 + - &194 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15254,7 +15600,7 @@ paths: - created_at additionalProperties: false examples: - default: &125 + default: &135 value: total_seats: 2 seats: @@ -15706,7 +16052,7 @@ paths: application/json: schema: type: array - items: &175 + items: &191 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16013,7 +16359,7 @@ paths: - date additionalProperties: true examples: - default: &176 + default: &192 value: - date: '2024-06-24' total_active_users: 24 @@ -16115,7 +16461,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &177 + '422': &193 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16126,6 +16472,212 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - *41 + - &118 + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + example: '2025-10-13' + responses: + '200': + description: Response + content: + application/json: + schema: &119 + type: object + title: Copilot Metrics 1 Day Report + description: Links to download the Copilot usage metrics report for + an enterprise for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the Copilot usage metrics report + for the enterprise for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + examples: + default: &120 + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": + get: + summary: Get Copilot enterprise usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &121 + type: object + title: Copilot Metrics 28 Day Report + description: Links to download the latest Copilot usage metrics report + for an enterprise. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the latest Copilot usage metrics + report for the enterprise. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` + format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` + format. + required: + - download_links + - report_start_day + - report_end_day + examples: + default: &122 + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - *41 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -16145,7 +16697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &303 + - &323 name: state in: query description: |- @@ -16154,7 +16706,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &304 + - &324 name: severity in: query description: |- @@ -16163,7 +16715,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &305 + - &325 name: ecosystem in: query description: |- @@ -16172,14 +16724,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &306 + - &326 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &307 + - &327 name: epss_percentage in: query description: |- @@ -16191,7 +16743,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &581 + - &598 name: has in: query description: |- @@ -16205,7 +16757,7 @@ paths: type: string enum: - patch - - &308 + - &328 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16215,7 +16767,7 @@ paths: enum: - development - runtime - - &309 + - &329 name: sort in: query description: |- @@ -16230,34 +16782,9 @@ paths: - updated - epss_percentage default: created - - *101 - - *99 - - *100 - - &310 - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - &311 - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 + - *106 + - *104 + - *105 - *17 responses: '200': @@ -16266,11 +16793,11 @@ paths: application/json: schema: type: array - items: &312 + items: &330 type: object description: A Dependabot alert. properties: - number: *113 + number: *123 state: type: string description: The state of the Dependabot alert. @@ -16285,7 +16812,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &114 + package: &124 type: object description: Details for the vulnerable package. readOnly: true @@ -16329,7 +16856,7 @@ paths: - unknown - direct - transitive - security_advisory: &582 + security_advisory: &599 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16359,13 +16886,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &117 + items: &127 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *114 + package: *124 severity: type: string description: The severity of the vulnerability. @@ -16431,8 +16958,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *115 - epss: *116 + cvss_severities: *125 + epss: *126 cwes: type: array description: Details for the advisory pertaining to Common @@ -16531,12 +17058,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *117 - url: *118 - html_url: *119 - created_at: *120 - updated_at: *121 - dismissed_at: *122 + security_vulnerability: *127 + url: *128 + html_url: *129 + created_at: *130 + updated_at: *131 + dismissed_at: *132 dismissed_by: title: Simple User description: A GitHub user. @@ -16560,15 +17087,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *123 - auto_dismissed_at: &583 + fixed_at: *133 + auto_dismissed_at: &600 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *110 + repository: *115 required: - number - state @@ -16587,7 +17114,7 @@ paths: - repository additionalProperties: false examples: - default: &313 + default: &331 value: - number: 2 state: dismissed @@ -17004,7 +17531,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - &182 + - &198 name: username description: The handle for the GitHub user account. in: path @@ -17026,9 +17553,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *124 + items: *134 examples: - default: *125 + default: *135 '500': *40 '401': *25 '403': *29 @@ -17071,7 +17598,7 @@ paths: type: integer network_configurations: type: array - items: &126 + items: &136 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -17111,7 +17638,7 @@ paths: - name - created_on examples: - default: &423 + default: &440 value: total_count: 2 network_configurations: @@ -17189,9 +17716,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: &127 + default: &137 value: id: 123456789ABCDEF name: My network configuration @@ -17218,7 +17745,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &128 + - &138 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -17230,9 +17757,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 headers: Link: *43 x-github: @@ -17252,7 +17779,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *128 + - *138 requestBody: required: true content: @@ -17291,9 +17818,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -17311,7 +17838,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *128 + - *138 responses: '204': description: Response @@ -17334,7 +17861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &424 + - &441 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -17346,7 +17873,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &442 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -17380,7 +17907,7 @@ paths: - subnet_id - region examples: - default: &426 + default: &443 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -17394,6 +17921,516 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations + "/enterprises/{enterprise}/org-properties/schema": + get: + summary: Get organization custom properties schema for an enterprise + description: |- + Gets all organization custom property definitions that are defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &139 + title: Custom Property for Organization + description: Custom property defined for an organization + allOf: + - type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or + delete info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + - type: object + properties: + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + examples: + default: &140 + value: + properties: + - property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + - property_name: service + url: https://api.github.com/enterprises/github/org-properties/schema/service + source_type: enterprise + value_type: string + - property_name: team + url: https://api.github.com/enterprises/github/org-properties/schema/team + source_type: enterprise + value_type: string + description: Team owning the organization + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update organization custom property definitions on an enterprise + description: |- + Creates new or updates existing organization custom properties defined on an enterprise in a batch. + + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of organization custom properties to create + or update. + items: *139 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: *140 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *139 + examples: + default: *140 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": + get: + summary: Get an organization custom property definition from an enterprise + description: |- + Gets an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + parameters: + - *41 + - &141 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *139 + examples: + default: &142 + value: + property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + put: + summary: Create or update an organization custom property definition on an enterprise + description: |- + Creates a new or updates an existing organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + parameters: + - *41 + - *141 + requestBody: + required: true + content: + application/json: + schema: + title: Organization Custom Property Payload + description: Payload for creating or updating an organization custom + property definition on an enterprise. + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property. + description: + type: string + nullable: true + description: Short description of the property. + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property. + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: *139 + examples: + default: *142 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + delete: + summary: Remove an organization custom property definition from an enterprise + description: |- + Removes an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + parameters: + - *41 + - *141 + responses: + '204': *143 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/values": + get: + summary: List custom property values for organizations in an enterprise + description: |- + Lists enterprise organizations with all of their custom property values. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + parameters: + - *41 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + title: Enterprise Organization Custom Property Values + description: List of custom property values for an organization + type: object + properties: + organization_id: + type: integer + example: 1296269 + organization_login: + type: string + example: Hello-World + properties: + type: array + items: &144 + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + description: List of custom property names and associated values + required: + - organization_id + - organization_login + - properties + examples: + default: + value: + - organization_id: 1296269 + organization_login: Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + headers: + Link: *43 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for organizations in an enterprise + description: |- + Create or update custom property values for organizations in an enterprise. + + To remove a custom property value from an organization, set the property value to `null`. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "edit enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + organization_logins: + type: array + description: The names of organizations that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the organizations. + items: *144 + required: + - organization_logins + - properties + examples: + default: + value: + organization_logins: + - acme + - github + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/properties/schema": get: summary: Get custom properties for an enterprise @@ -17415,7 +18452,7 @@ paths: application/json: schema: type: array - items: &129 + items: &145 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -17481,7 +18518,7 @@ paths: - property_name - value_type examples: - default: &130 + default: &146 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -17538,7 +18575,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *129 + items: *145 minItems: 1 maxItems: 100 required: @@ -17568,9 +18605,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -17593,22 +18630,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *78 - - &131 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *83 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: &132 + default: &147 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -17641,15 +18672,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -17671,12 +18702,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 requestBody: required: true content: application/json: - schema: &388 + schema: &406 title: Custom Property Set Payload description: Custom property set payload type: object @@ -17740,9 +18771,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -17764,9 +18795,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 responses: - '204': *133 + '204': *143 '403': *29 '404': *6 x-github: @@ -17806,7 +18837,7 @@ paths: - push - repository default: branch - enforcement: &140 + enforcement: &156 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -17819,7 +18850,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &141 + items: &157 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -17860,7 +18891,7 @@ paths: - pull_request - exempt default: always - conditions: &164 + conditions: &180 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -17874,7 +18905,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &134 + - &148 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -17900,7 +18931,7 @@ paths: type: string required: - organization_name - - &137 + - &151 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -17929,7 +18960,7 @@ paths: is prevented. required: - repository_name - - &136 + - &150 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -17957,8 +18988,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *134 - - &139 + - *148 + - &153 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -17971,7 +19002,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &135 + items: &149 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -18002,16 +19033,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *135 + items: *149 required: - repository_property - - *136 + - *150 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &138 + - &152 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -18028,25 +19059,80 @@ paths: type: integer required: - organization_id - - *137 - - *136 + - *151 + - *150 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *138 - - *139 - - *136 + - *152 + - *153 + - *150 + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and + all repositories + allOf: + - &155 + title: Repository ruleset conditions for organization properties + type: object + description: Parameters for a organization property condition + properties: + organization_property: + type: object + properties: + include: + type: array + description: The organization properties and values + to include. All of these properties must match for + the condition to pass. + items: &154 + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a organization + property + properties: + name: + type: string + description: The name of the organization property + to target + property_values: + type: array + description: The values to match for the organization + property + items: + type: string + required: + - name + - property_values + exclude: + type: array + description: The organization properties and values + to exclude. The condition will not pass if any of + these properties match. + items: *154 + required: + - organization_property + - *151 + - *150 + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and + repositories by property + allOf: + - *155 + - *153 + - *150 rules: type: array description: An array of rules within the ruleset. - items: &165 + items: &181 title: Repository Rule type: object description: A repository rule. oneOf: - - &142 + - &158 title: creation description: Only allow users with bypass permission to create matching refs. @@ -18058,7 +19144,7 @@ paths: type: string enum: - creation - - &143 + - &159 title: update description: Only allow users with bypass permission to update matching refs. @@ -18079,7 +19165,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &144 + - &160 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -18091,7 +19177,7 @@ paths: type: string enum: - deletion - - &145 + - &161 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -18103,7 +19189,7 @@ paths: type: string enum: - required_linear_history - - &146 + - &162 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -18127,7 +19213,7 @@ paths: type: string required: - required_deployment_environments - - &147 + - &163 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -18139,7 +19225,7 @@ paths: type: string enum: - required_signatures - - &148 + - &164 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -18199,7 +19285,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &149 + - &165 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -18246,7 +19332,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &150 + - &166 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -18258,7 +19344,7 @@ paths: type: string enum: - non_fast_forward - - &151 + - &167 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -18294,7 +19380,7 @@ paths: required: - operator - pattern - - &152 + - &168 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -18330,7 +19416,7 @@ paths: required: - operator - pattern - - &153 + - &169 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -18366,7 +19452,7 @@ paths: required: - operator - pattern - - &154 + - &170 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -18402,7 +19488,7 @@ paths: required: - operator - pattern - - &155 + - &171 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -18438,7 +19524,7 @@ paths: required: - operator - pattern - - &156 + - &172 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -18462,7 +19548,7 @@ paths: type: string required: - restricted_file_paths - - &157 + - &173 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -18486,7 +19572,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &158 + - &174 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -18509,7 +19595,7 @@ paths: type: string required: - restricted_file_extensions - - &159 + - &175 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -18533,7 +19619,7 @@ paths: maximum: 100 required: - max_file_size - - &160 + - &176 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -18582,7 +19668,7 @@ paths: - repository_id required: - workflows - - &161 + - &177 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -18668,7 +19754,7 @@ paths: description: Response content: application/json: - schema: &162 + schema: &178 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -18703,11 +19789,11 @@ paths: source: type: string description: The name of the source - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 + items: *157 current_user_can_bypass: type: string description: |- @@ -18739,8 +19825,8 @@ paths: conditions: nullable: true anyOf: - - *136 - - &395 + - *150 + - &412 title: Organization ruleset conditions type: object description: |- @@ -18754,14 +19840,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *136 - - *137 + - *150 + - *151 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *136 + - *150 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -18783,20 +19869,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *136 - - *139 + - *150 + - *153 rules: type: array - items: &703 + items: &722 title: Repository Rule type: object description: A repository rule. oneOf: - - *142 - - *143 - - *144 - - *145 - - &700 + - *158 + - *159 + - *160 + - *161 + - &719 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -18874,23 +19960,23 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - - *158 - - *159 - - *160 - - *161 - - &701 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - *174 + - *175 + - *176 + - *177 + - &720 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -18920,7 +20006,7 @@ paths: type: string format: date-time examples: - default: &163 + default: &179 value: id: 21 name: super cool ruleset @@ -18979,9 +20065,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *163 + default: *179 '404': *6 '500': *40 x-github: @@ -19025,16 +20111,16 @@ paths: - tag - push - repository - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *164 + items: *157 + conditions: *180 rules: description: An array of rules within the ruleset. type: array - items: *165 + items: *181 examples: default: value: @@ -19058,9 +20144,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *163 + default: *179 '404': *6 '500': *40 x-github: @@ -19122,7 +20208,7 @@ paths: application/json: schema: type: array - items: &166 + items: &182 title: Ruleset version type: object description: The historical version of a ruleset @@ -19146,7 +20232,7 @@ paths: type: string format: date-time examples: - default: &398 + default: &415 value: - version_id: 3 actor: @@ -19199,9 +20285,9 @@ paths: description: Response content: application/json: - schema: &399 + schema: &416 allOf: - - *166 + - *182 - type: object required: - state @@ -19254,7 +20340,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &400 + - &417 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -19265,7 +20351,7 @@ paths: enum: - open - resolved - - &401 + - &418 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -19275,7 +20361,7 @@ paths: required: false schema: type: string - - &402 + - &419 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -19284,7 +20370,7 @@ paths: required: false schema: type: string - - &403 + - &420 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -19296,11 +20382,11 @@ paths: - created - updated default: created - - *101 + - *106 - *17 - - *99 - - *100 - - &404 + - *104 + - *105 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -19309,7 +20395,7 @@ paths: required: false schema: type: string - - &405 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -19318,7 +20404,7 @@ paths: schema: type: boolean default: false - - &406 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -19327,7 +20413,7 @@ paths: schema: type: boolean default: false - - &407 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -19343,11 +20429,11 @@ paths: application/json: schema: type: array - items: &408 + items: &425 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -19355,21 +20441,21 @@ paths: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &715 + state: &734 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &716 + resolution: &735 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -19403,7 +20489,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *110 + repository: *115 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -19476,8 +20562,8 @@ paths: pull request. ' - oneOf: &717 - - &719 + oneOf: &736 + - &738 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -19529,7 +20615,7 @@ paths: - blob_url - commit_sha - commit_url - - &720 + - &739 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -19584,7 +20670,7 @@ paths: - page_url - commit_sha - commit_url - - &721 + - &740 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -19598,7 +20684,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &722 + - &741 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -19612,7 +20698,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &723 + - &742 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -19626,7 +20712,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &724 + - &743 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -19640,7 +20726,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &725 + - &744 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -19654,7 +20740,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &726 + - &745 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -19668,7 +20754,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &727 + - &746 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -19682,7 +20768,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &728 + - &747 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -19696,7 +20782,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &729 + - &748 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -19710,7 +20796,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &730 + - &749 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -19724,7 +20810,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &731 + - &750 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -19751,7 +20837,7 @@ paths: required: *21 nullable: true examples: - default: &409 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -19929,9 +21015,9 @@ paths: headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -19960,13 +21046,13 @@ paths: description: Response content: application/json: - schema: &410 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: - pattern_config_version: &169 + pattern_config_version: &185 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -19975,7 +21061,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &168 + items: &184 type: object properties: token_type: @@ -20041,9 +21127,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *168 + items: *184 examples: - default: &411 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -20098,7 +21184,7 @@ paths: schema: type: object properties: - pattern_config_version: *169 + pattern_config_version: *185 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -20124,7 +21210,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *169 + custom_pattern_version: *185 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -20160,7 +21246,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: @@ -20187,7 +21273,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &431 type: object properties: total_minutes_used: @@ -20257,7 +21343,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &415 + default: &432 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -20288,7 +21374,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &416 + - &433 name: advanced_security_product in: query description: | @@ -20308,7 +21394,7 @@ paths: description: Success content: application/json: - schema: &417 + schema: &434 type: object properties: total_advanced_security_committers: @@ -20363,7 +21449,7 @@ paths: required: - repositories examples: - default: &418 + default: &435 value: total_advanced_security_committers: 2 total_count: 2 @@ -20402,6 +21488,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - *41 + - name: state + in: query + description: Set to `active` or `deleted` to only list cost centers in a specific + state. + required: false + schema: + type: string + enum: + - active + - deleted responses: '200': description: Response when getting cost centers @@ -20473,7 +21569,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20602,7 +21698,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &172 + - &188 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -20614,7 +21710,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &170 + schema: &186 type: object properties: id: @@ -20653,7 +21749,7 @@ paths: - name - resources examples: - default: &171 + default: &187 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -20667,7 +21763,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20717,15 +21813,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *170 + schema: *186 examples: - default: *171 + default: *187 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20743,7 +21839,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *172 + - *188 responses: '200': description: Response when deleting a cost center @@ -20782,7 +21878,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20803,7 +21899,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *172 + - *188 requestBody: required: true content: @@ -20873,9 +21969,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *29 - '409': *109 + '409': *114 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20895,7 +21991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *172 + - *188 requestBody: required: true content: @@ -20942,7 +22038,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20973,7 +22069,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &436 type: object properties: total_gigabytes_bandwidth_used: @@ -20991,7 +22087,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &420 + default: &437 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -21004,8 +22100,10 @@ paths: "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise - description: Gets a report of premium request usage for an enterprise. To use - this endpoint, you must be an administrator or billing manager of the enterprise. + description: |- + Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe @@ -21014,7 +22112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &173 + - &189 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -21023,7 +22121,7 @@ paths: required: false schema: type: integer - - &222 + - &240 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -21032,7 +22130,7 @@ paths: required: false schema: type: integer - - &174 + - &190 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -21048,21 +22146,21 @@ paths: required: false schema: type: string - - &223 + - &241 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &224 + - &242 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &225 + - &243 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -21146,19 +22244,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -21201,7 +22299,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21232,7 +22330,7 @@ paths: description: Response content: application/json: - schema: &421 + schema: &438 type: object properties: days_left_in_billing_cycle: @@ -21250,7 +22348,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &422 + default: &439 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -21275,8 +22373,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *173 - - &226 + - *189 + - &244 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -21285,8 +22383,8 @@ paths: required: false schema: type: integer - - *174 - - &227 + - *190 + - &245 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -21307,7 +22405,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &228 + schema: &246 type: object properties: usageItems: @@ -21360,7 +22458,7 @@ paths: - netAmount - organizationName examples: - default: &229 + default: &247 value: usageItems: - date: '2023-08-01' @@ -21377,7 +22475,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21448,13 +22546,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -21481,9 +22579,9 @@ paths: application/json: schema: type: array - items: *178 + items: *194 examples: - default: &179 + default: &195 value: - id: 1 name: Justice League @@ -21539,6 +22637,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -21557,9 +22667,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21577,7 +22687,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &180 + - &196 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -21596,7 +22706,7 @@ paths: type: array items: *4 examples: - default: &181 + default: &197 value: - login: octocat id: 1 @@ -21635,7 +22745,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *180 + - *196 requestBody: required: true content: @@ -21666,7 +22776,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21684,7 +22794,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *180 + - *196 requestBody: required: true content: @@ -21715,7 +22825,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21733,8 +22843,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '200': description: User is a member of the enterprise team. @@ -21742,7 +22852,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &183 + exampleKey1: &199 value: login: octocat id: 1 @@ -21778,8 +22888,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '201': description: Successfully added team member @@ -21787,7 +22897,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *183 + exampleKey1: *199 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21805,8 +22915,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '204': description: Response @@ -21816,6 +22926,227 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - *41 + - *196 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: *69 + examples: + default: &200 + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - *41 + - *196 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: *69 + examples: + default: &237 + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - *41 + - *196 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *69 + examples: + default: *200 + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *69 + examples: + default: *200 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -21831,7 +23162,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &184 + - &201 name: team_slug description: The slug of the team name. in: path @@ -21843,9 +23174,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 headers: Link: *43 '403': *29 @@ -21865,7 +23196,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *184 + - *201 requestBody: required: true content: @@ -21891,6 +23222,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -21908,9 +23251,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 headers: Link: *43 '403': *29 @@ -21933,7 +23276,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *184 + - *201 responses: '204': description: Response @@ -22032,7 +23375,7 @@ paths: application/json: schema: type: array - items: &215 + items: &232 title: Event description: Event type: object @@ -22042,7 +23385,7 @@ paths: type: type: string nullable: true - actor: &185 + actor: &202 title: Actor description: Actor type: object @@ -22082,7 +23425,7 @@ paths: - id - name - url - org: *185 + org: *202 payload: oneOf: - title: CreateEvent @@ -22128,7 +23471,7 @@ paths: properties: action: type: string - discussion: &854 + discussion: &872 title: Discussion description: A Discussion in a repository. type: object @@ -22415,7 +23758,7 @@ paths: - id labels: type: array - items: &188 + items: &205 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -22490,12 +23833,12 @@ paths: properties: action: type: string - issue: &189 + issue: &206 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &640 + properties: &657 id: type: integer format: int64 @@ -22609,7 +23952,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &380 + properties: &398 url: type: string format: uri @@ -22679,7 +24022,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &381 + required: &399 - closed_issues - creator - description @@ -22758,7 +24101,7 @@ paths: timeline_url: type: string format: uri - type: &342 + type: &360 title: Issue Type description: The type of issue. type: object @@ -22808,7 +24151,7 @@ paths: - node_id - name - description - repository: *69 + repository: *74 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -22819,9 +24162,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - author_association: &190 + properties: *203 + required: *204 + author_association: &207 title: author_association type: string example: OWNER @@ -22836,7 +24179,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &191 + reactions: &208 title: Reaction Rollup type: object properties: @@ -22872,7 +24215,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &775 + sub_issues_summary: &794 title: Sub-issues Summary type: object properties: @@ -22892,7 +24235,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &776 + issue_dependencies_summary: &795 title: Issue Dependencies Summary type: object properties: @@ -22911,7 +24254,7 @@ paths: - total_blocking issue_field_values: type: array - items: &777 + items: &796 title: Issue Field Value description: A value assigned to an issue field type: object @@ -22972,7 +24315,7 @@ paths: - node_id - data_type - value - required: &641 + required: &658 - assignee - closed_at - comments @@ -22997,10 +24340,10 @@ paths: assignees: type: array items: *4 - label: *188 + label: *205 labels: type: array - items: *188 + items: *205 required: - action - issue @@ -23009,8 +24352,8 @@ paths: properties: action: type: string - issue: *189 - comment: &638 + issue: *206 + comment: &655 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -23058,7 +24401,7 @@ paths: issue_url: type: string format: uri - author_association: *190 + author_association: *207 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -23069,9 +24412,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - id - node_id @@ -23244,8 +24587,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true allow_forking: type: boolean @@ -23334,7 +24677,7 @@ paths: type: string number: type: integer - pull_request: &194 + pull_request: &211 title: Pull Request Minimal type: object properties: @@ -23405,10 +24748,10 @@ paths: assignees: type: array items: *4 - label: *188 + label: *205 labels: type: array - items: *188 + items: *205 required: - action - number @@ -23418,7 +24761,7 @@ paths: properties: action: type: string - pull_request: *194 + pull_request: *211 comment: type: object properties: @@ -23669,7 +25012,7 @@ paths: - pull_request updated_at: type: string - pull_request: *194 + pull_request: *211 required: - action - review @@ -23718,7 +25061,7 @@ paths: updated_at: type: string format: date-time - reactions: *191 + reactions: *208 required: - action - comment @@ -23729,7 +25072,7 @@ paths: type: string release: allOf: - - &693 + - &712 title: Release description: A release. type: object @@ -23800,7 +25143,7 @@ paths: author: *4 assets: type: array - items: &694 + items: &713 title: Release Asset description: Data related to a release. type: object @@ -23875,7 +25218,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *191 + reactions: *208 required: - assets_url - upload_url @@ -23967,7 +25310,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24048,7 +25391,7 @@ paths: _links: type: object properties: - timeline: &195 + timeline: &212 title: Link With Type description: Hypermedia Link with Type type: object @@ -24060,17 +25403,17 @@ paths: required: - href - type - user: *195 - security_advisories: *195 - current_user: *195 - current_user_public: *195 - current_user_actor: *195 - current_user_organization: *195 + user: *212 + security_advisories: *212 + current_user: *212 + current_user_public: *212 + current_user_actor: *212 + current_user_organization: *212 current_user_organizations: type: array - items: *195 - repository_discussions: *195 - repository_discussions_category: *195 + items: *212 + repository_discussions: *212 + repository_discussions_category: *212 required: - timeline - user @@ -24132,7 +25475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24142,7 +25485,7 @@ paths: application/json: schema: type: array - items: &197 + items: &214 title: Base Gist description: Base Gist type: object @@ -24241,7 +25584,7 @@ paths: - created_at - updated_at examples: - default: &198 + default: &215 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -24362,7 +25705,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &216 title: Gist Simple description: Gist Simple type: object @@ -24379,7 +25722,7 @@ paths: url: type: string format: uri - user: &789 + user: &808 title: Public User description: Public User type: object @@ -24741,7 +26084,7 @@ paths: truncated: type: boolean examples: - default: &200 + default: &217 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -24845,7 +26188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24855,9 +26198,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '422': *15 @@ -24879,7 +26222,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24889,9 +26232,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '401': *25 @@ -24919,7 +26262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &201 + - &218 name: gist_id description: The unique identifier of the gist. in: path @@ -24931,10 +26274,10 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - default: *200 - '403': &204 + default: *217 + '403': &221 description: Forbidden Gist content: application/json: @@ -24982,7 +26325,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *201 + - *218 requestBody: required: true content: @@ -25042,9 +26385,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - updateGist: *200 + updateGist: *217 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -25202,7 +26545,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25231,7 +26574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25241,7 +26584,7 @@ paths: application/json: schema: type: array - items: &202 + items: &219 title: Gist Comment description: A comment made to a gist. type: object @@ -25276,7 +26619,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *190 + author_association: *207 required: - url - id @@ -25341,7 +26684,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *201 + - *218 requestBody: required: true content: @@ -25366,9 +26709,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: &203 + default: &220 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -25426,8 +26769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *201 - - &205 + - *218 + - &222 name: comment_id description: The unique identifier of the comment. in: path @@ -25440,12 +26783,12 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: *203 + default: *220 '304': *37 '404': *6 - '403': *204 + '403': *221 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25467,8 +26810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *201 - - *205 + - *218 + - *222 requestBody: required: true content: @@ -25493,9 +26836,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: *203 + default: *220 '404': *6 x-github: githubCloudOnly: false @@ -25512,8 +26855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *201 - - *205 + - *218 + - *222 responses: '204': description: Response @@ -25536,7 +26879,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25637,7 +26980,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25647,7 +26990,7 @@ paths: application/json: schema: type: array - items: *199 + items: *216 examples: default: value: @@ -25712,13 +27055,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *201 + - *218 responses: '201': description: Response content: application/json: - schema: *197 + schema: *214 examples: default: value: @@ -25789,7 +27132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *201 + - *218 responses: '204': description: Response if gist is starred @@ -25819,7 +27162,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25841,7 +27184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25870,7 +27213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *201 + - *218 - name: sha in: path required: true @@ -25881,9 +27224,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - default: *200 + default: *217 '422': *15 '404': *6 '403': *29 @@ -26042,7 +27385,7 @@ paths: type: integer repositories: type: array - items: *69 + items: *74 repository_selection: type: string example: selected @@ -26249,7 +27592,7 @@ paths: - closed - all default: open - - &345 + - &363 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -26267,8 +27610,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - name: collab in: query required: false @@ -26298,9 +27641,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: &346 + default: &364 value: - id: 1 node_id: MDU6SXNzdWUx @@ -26584,8 +27927,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 examples: default: value: @@ -26870,7 +28213,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &206 + X-CommonMarker-Version: &223 example: 0.17.4 schema: type: string @@ -26925,7 +28268,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *206 + X-CommonMarker-Version: *223 content: text/html: schema: @@ -26954,7 +28297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &209 + - &226 name: account_id description: account_id parameter in: path @@ -26966,7 +28309,7 @@ paths: description: Response content: application/json: - schema: &208 + schema: &225 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -26996,7 +28339,7 @@ paths: nullable: true id: type: integer - plan: &207 + plan: &224 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27085,7 +28428,7 @@ paths: nullable: true updated_at: type: string - plan: *207 + plan: *224 required: - url - id @@ -27093,7 +28436,7 @@ paths: - login - marketplace_purchase examples: - default: &210 + default: &227 value: url: https://api.github.com/orgs/github type: Organization @@ -27178,9 +28521,9 @@ paths: application/json: schema: type: array - items: *207 + items: *224 examples: - default: &211 + default: &228 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -27220,14 +28563,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &212 + - &229 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &213 + - &230 name: sort description: The property to sort the results by. in: query @@ -27257,9 +28600,9 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: - default: &214 + default: &231 value: - url: https://api.github.com/orgs/github type: Organization @@ -27333,15 +28676,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *209 + - *226 responses: '200': description: Response content: application/json: - schema: *208 + schema: *225 examples: - default: *210 + default: *227 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -27373,9 +28716,9 @@ paths: application/json: schema: type: array - items: *207 + items: *224 examples: - default: *211 + default: *228 headers: Link: *43 '401': *25 @@ -27398,8 +28741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *212 - - *213 + - *229 + - *230 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -27419,9 +28762,9 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: - default: *214 + default: *231 headers: Link: *43 '401': *25 @@ -27685,14 +29028,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &446 + - &463 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &447 + - &464 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -27709,7 +29052,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -27754,7 +29097,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &460 + '301': &477 description: Moved permanently content: application/json: @@ -27776,7 +29119,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &669 + - &686 name: all description: If `true`, show notifications marked as read. in: query @@ -27784,7 +29127,7 @@ paths: schema: type: boolean default: false - - &670 + - &687 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -27793,8 +29136,8 @@ paths: schema: type: boolean default: false - - *196 - - &671 + - *213 + - &688 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -27819,18 +29162,18 @@ paths: application/json: schema: type: array - items: &216 + items: &233 title: Thread description: Thread type: object properties: id: type: string - repository: &255 + repository: &275 title: Minimal Repository description: Minimal Repository type: object - properties: &315 + properties: &333 id: type: integer format: int64 @@ -28106,7 +29449,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &392 + security_and_analysis: &409 nullable: true type: object properties: @@ -28188,7 +29531,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &316 + required: &334 - archive_url - assignees_url - blobs_url @@ -28276,7 +29619,7 @@ paths: - url - subscription_url examples: - default: &672 + default: &689 value: - id: '1' repository: @@ -28442,7 +29785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &217 + - &234 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -28456,7 +29799,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *233 examples: default: value: @@ -28559,7 +29902,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *217 + - *234 responses: '205': description: Reset Content @@ -28582,7 +29925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *217 + - *234 responses: '204': description: No content @@ -28605,13 +29948,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *217 + - *234 responses: '200': description: Response content: application/json: - schema: &218 + schema: &235 title: Thread Subscription description: Thread Subscription type: object @@ -28648,7 +29991,7 @@ paths: - url - subscribed examples: - default: &219 + default: &236 value: subscribed: true ignored: false @@ -28679,7 +30022,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *217 + - *234 requestBody: required: false content: @@ -28700,9 +30043,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *235 examples: - default: *219 + default: *236 '304': *37 '403': *29 '401': *25 @@ -28725,7 +30068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *217 + - *234 responses: '204': description: Response @@ -28820,22 +30163,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: &806 - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default: *237 headers: Link: example: ; rel="next" @@ -28886,7 +30216,7 @@ paths: type: integer custom_roles: type: array - items: &298 + items: &318 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -28934,7 +30264,7 @@ paths: - created_at - updated_at examples: - default: &299 + default: &319 value: id: 8030 name: Security Engineer @@ -28981,7 +30311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *78 + - *83 - name: page in: query description: The page number of results to fetch. @@ -29025,8 +30355,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *220 - required: *221 + properties: *238 + required: *239 nullable: true additionalProperties: false examples: @@ -29132,7 +30462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -29198,7 +30528,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *78 + - *83 requestBody: required: true content: @@ -29231,12 +30561,113 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *144 + examples: + default: &695 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - *83 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: *144 + required: + - properties + examples: + default: &696 + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -29244,13 +30675,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *78 - - *173 - - *222 - - *174 - - *223 - - *224 - - *225 + - *83 + - *189 + - *240 + - *190 + - *241 + - *242 + - *243 responses: '200': description: Response when getting a billing premium request usage report @@ -29306,19 +30737,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -29361,7 +30792,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29381,23 +30812,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *78 - - *173 - - *226 - - *174 - - *227 + - *83 + - *189 + - *244 + - *190 + - *245 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *228 + schema: *246 examples: - default: *229 + default: *247 '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29423,13 +30854,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &230 + schema: &248 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -29762,7 +31193,7 @@ paths: - updated_at - archived_at examples: - default-response: &231 + default-response: &249 value: login: github id: 1 @@ -29864,7 +31295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *78 + - *83 requestBody: required: false content: @@ -30087,18 +31518,18 @@ paths: description: Response content: application/json: - schema: *230 + schema: *248 examples: - default: *231 + default: *249 '422': description: Validation failed content: application/json: schema: oneOf: - - *232 - - *233 - '409': *109 + - *250 + - *251 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30121,7 +31552,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *78 + - *83 responses: '202': *39 '404': *6 @@ -30146,15 +31577,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *234 + schema: *252 examples: - default: *235 + default: *253 headers: Link: *43 x-github: @@ -30177,7 +31608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -30195,7 +31626,7 @@ paths: type: integer repository_cache_usages: type: array - items: &465 + items: &482 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -30250,7 +31681,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -30270,7 +31701,7 @@ paths: type: array items: *44 examples: - default: *236 + default: *254 headers: Link: *43 x-github: @@ -30290,7 +31721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -30319,6 +31750,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -30336,6 +31772,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -30359,12 +31800,195 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: *45 + examples: + default: *47 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *83 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: *45 + examples: + default: *255 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - *83 + - *46 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - *46 + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: *48 + examples: + default: *47 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - *83 + - *46 + - *49 + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: *256 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - *83 + - *46 + - *49 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -30377,7 +32001,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30393,9 +32017,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30413,7 +32037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30429,9 +32053,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30448,15 +32072,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *237 + schema: *257 examples: - default: *238 + default: *258 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30474,7 +32098,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30490,9 +32114,9 @@ paths: type: integer machine_specs: type: array - items: *47 + items: *52 examples: - default: *239 + default: *259 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30510,7 +32134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30554,8 +32178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 responses: '200': description: Response @@ -30563,7 +32187,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 headers: Link: *43 x-github: @@ -30583,8 +32207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 requestBody: required: true content: @@ -30610,6 +32234,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -30624,7 +32253,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -30640,8 +32269,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 responses: '202': description: Response @@ -30649,7 +32278,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -30669,13 +32298,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *78 + - *83 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &240 + schema: &260 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -30689,7 +32318,7 @@ paths: required: - include_claim_keys examples: - default: &241 + default: &261 value: include_claim_keys: - repo @@ -30711,20 +32340,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *240 + schema: *260 examples: - default: *241 + default: *261 responses: '201': description: Empty response content: application/json: - schema: &266 + schema: &286 title: Empty Object description: An object without any properties. type: object @@ -30754,7 +32383,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30763,7 +32392,7 @@ paths: schema: type: object properties: - enabled_repositories: &243 + enabled_repositories: &263 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -30776,9 +32405,9 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: *51 - selected_actions_url: *242 - sha_pinning_required: *52 + allowed_actions: *56 + selected_actions_url: *262 + sha_pinning_required: *57 required: - enabled_repositories examples: @@ -30808,7 +32437,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -30819,9 +32448,9 @@ paths: schema: type: object properties: - enabled_repositories: *243 - allowed_actions: *51 - sha_pinning_required: *52 + enabled_repositories: *263 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled_repositories examples: @@ -30849,13 +32478,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: response: summary: Example response @@ -30881,12 +32510,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *245 + schema: *265 examples: application/json: value: @@ -30896,7 +32525,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -30916,15 +32545,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *53 + schema: *58 examples: - default: *246 + default: *266 '404': *6 x-github: enabledForGitHubApps: true @@ -30943,7 +32572,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -30953,7 +32582,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -30975,15 +32604,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *247 + schema: *267 examples: - default: *54 + default: *59 '403': *29 '404': *6 x-github: @@ -31001,14 +32630,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *248 + schema: *268 examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -31038,7 +32667,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -31056,9 +32685,9 @@ paths: type: number repositories: type: array - items: *69 + items: *74 examples: - default: &250 + default: &270 value: total_count: 1 repositories: @@ -31198,7 +32827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -31242,8 +32871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *78 - - &249 + - *83 + - &269 name: repository_id description: The unique identifier of the repository. in: path @@ -31271,8 +32900,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -31295,15 +32924,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *56 + schema: *61 examples: - default: *57 + default: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31326,7 +32955,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -31334,9 +32963,9 @@ paths: required: false content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31356,7 +32985,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -31404,7 +33033,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31431,7 +33060,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31451,7 +33080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -31466,9 +33095,9 @@ paths: type: integer repositories: type: array - items: *69 + items: *74 examples: - default: *250 + default: *270 '403': *29 '404': *6 x-github: @@ -31488,7 +33117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31536,14 +33165,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31563,14 +33192,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31592,15 +33221,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *251 + schema: *271 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31621,7 +33250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Success response @@ -31632,9 +33261,9 @@ paths: required: false content: application/json: - schema: *252 + schema: *272 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31654,7 +33283,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *78 + - *83 - *17 - *19 - name: visible_to_repository @@ -31679,7 +33308,7 @@ paths: type: number runner_groups: type: array - items: &253 + items: &273 type: object properties: id: @@ -31795,7 +33424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31867,9 +33496,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *273 examples: - default: &254 + default: &274 value: id: 2 name: octo-runner-group @@ -31904,14 +33533,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 responses: '200': description: Response content: application/json: - schema: *253 + schema: *273 examples: default: value: @@ -31947,8 +33576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32002,9 +33631,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *273 examples: - default: *254 + default: *274 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32023,8 +33652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *78 - - *63 + - *83 + - *68 responses: '204': description: Response @@ -32047,8 +33676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *17 - *19 responses: @@ -32068,7 +33697,7 @@ paths: type: array items: *44 examples: - default: *236 + default: *254 headers: Link: *43 x-github: @@ -32090,8 +33719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *19 - *17 responses: @@ -32109,9 +33738,9 @@ paths: type: number repositories: type: array - items: *255 + items: *275 examples: - default: &792 + default: &811 value: total_count: 1 repositories: @@ -32363,8 +33992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32408,9 +34037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 - - *249 + - *83 + - *68 + - *269 responses: '204': description: Response @@ -32432,9 +34061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 - - *249 + - *83 + - *68 + - *269 responses: '204': description: Response @@ -32457,8 +34086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *17 - *19 responses: @@ -32476,9 +34105,9 @@ paths: type: number runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -32499,8 +34128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32544,9 +34173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *78 - - *63 - - *66 + - *83 + - *68 + - *71 responses: '204': description: Response @@ -32568,9 +34197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *78 - - *63 - - *66 + - *83 + - *68 + - *71 responses: '204': description: Response @@ -32600,7 +34229,7 @@ paths: in: query schema: type: string - - *78 + - *83 - *17 - *19 responses: @@ -32618,9 +34247,9 @@ paths: type: integer runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -32644,7 +34273,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -32652,9 +34281,9 @@ paths: application/json: schema: type: array - items: *256 + items: *276 examples: - default: *257 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32676,7 +34305,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -32719,10 +34348,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *278 '404': *6 '422': *7 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32750,15 +34379,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *78 + - *83 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *259 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32786,15 +34415,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *78 + - *83 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32816,16 +34445,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: *261 + default: *281 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32846,8 +34475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: '204': description: Response @@ -32873,10 +34502,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: - '200': *72 + '200': *77 '404': *6 x-github: githubCloudOnly: false @@ -32898,8 +34527,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 requestBody: required: true content: @@ -32923,7 +34552,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -32947,8 +34576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 requestBody: required: true content: @@ -32973,7 +34602,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -32997,10 +34626,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: - '200': *262 + '200': *282 '404': *6 x-github: githubCloudOnly: false @@ -33027,11 +34656,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 - - *263 + - *83 + - *71 + - *283 responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -33056,7 +34685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -33074,7 +34703,7 @@ paths: type: integer secrets: type: array - items: &264 + items: &284 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -33147,13 +34776,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &485 + schema: &502 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -33182,7 +34811,7 @@ paths: - key_id - key examples: - default: &486 + default: &503 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33207,8 +34836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *78 - - &265 + - *83 + - &285 name: secret_name description: The name of the secret. in: path @@ -33220,7 +34849,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *284 examples: default: value: @@ -33250,8 +34879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -33308,7 +34937,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -33334,8 +34963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -33361,8 +34990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -33380,9 +35009,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: &269 + default: &289 value: total_count: 1 repositories: @@ -33474,8 +35103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -33527,8 +35156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -33561,8 +35190,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -33594,8 +35223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *78 - - &470 + - *83 + - &487 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -33619,7 +35248,7 @@ paths: type: integer variables: type: array - items: &267 + items: &287 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -33704,7 +35333,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *78 + - *83 requestBody: required: true content: @@ -33752,7 +35381,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -33777,8 +35406,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *78 - - &268 + - *83 + - &288 name: name description: The name of the variable. in: path @@ -33790,7 +35419,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *287 examples: default: value: @@ -33820,8 +35449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 requestBody: required: true content: @@ -33883,8 +35512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 responses: '204': description: Response @@ -33910,8 +35539,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - *19 - *17 responses: @@ -33929,9 +35558,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 '409': description: Response when the visibility of the variable is not set to `selected` @@ -33957,8 +35586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 requestBody: required: true content: @@ -34007,8 +35636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - name: repository_id in: path required: true @@ -34042,8 +35671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - name: repository_id in: path required: true @@ -34074,15 +35703,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34101,19 +35730,19 @@ paths: required: true content: application/json: - schema: *270 + schema: *290 examples: - default: *76 + default: *81 parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34129,7 +35758,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -34152,7 +35781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *78 + - *83 requestBody: required: true content: @@ -34284,7 +35913,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *78 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -34367,9 +35996,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *99 - - *100 - - *78 + - *104 + - *105 + - *83 requestBody: required: true content: @@ -34392,12 +36021,12 @@ paths: required: - subject_digests examples: - default: &821 + default: &839 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &822 + withPredicateType: &840 value: subject_digests: - sha256:abc123 @@ -34455,7 +36084,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &823 + default: &841 value: attestations_subject_digests: - sha256:abc: @@ -34564,7 +36193,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *78 + - *83 requestBody: required: true content: @@ -34629,7 +36258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *78 + - *83 - name: subject_digest description: Subject Digest in: path @@ -34648,6 +36277,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + parameters: + - *17 + - *104 + - *105 + - *83 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -34660,7 +36340,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *78 + - *83 - name: attestation_id description: Attestation ID in: path @@ -34696,9 +36376,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *99 - - *100 - - *78 + - *104 + - *105 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -34751,7 +36431,7 @@ paths: initiator: type: string examples: - default: &499 + default: &516 value: attestations: - bundle: @@ -34869,7 +36549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *78 + - *83 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -34877,10 +36557,10 @@ paths: required: false schema: type: string - - *271 - - *272 - - *273 - - *274 + - *291 + - *292 + - *293 + - *294 - *17 responses: '200': @@ -34889,9 +36569,9 @@ paths: application/json: schema: type: array - items: *275 + items: *295 examples: - default: *276 + default: *296 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34908,7 +36588,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -34920,7 +36600,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34939,8 +36619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: If the user is blocked @@ -34965,8 +36645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -34986,8 +36666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -35013,17 +36693,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *78 - - &279 + - *83 + - &299 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *94 - - *95 - - *96 - - *97 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -35033,9 +36713,9 @@ paths: application/json: schema: type: array - items: *277 + items: *297 examples: - default: *278 + default: *298 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -35058,12 +36738,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *78 - - *279 - - *94 - - *95 - - *96 - - *97 + - *83 + - *299 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -35073,9 +36753,9 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -35094,15 +36774,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *78 + - *83 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &283 + schema: &303 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -35128,7 +36808,7 @@ paths: application/json: schema: type: array - items: &284 + items: &304 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -35159,7 +36839,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *282 + items: *302 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -35177,7 +36857,7 @@ paths: type: string format: date-time nullable: true - state: *283 + state: *303 contact_link: description: The contact link of the campaign. type: string @@ -35274,7 +36954,7 @@ paths: headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35298,7 +36978,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -35362,6 +37042,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -35371,7 +37052,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -35392,9 +37077,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: &285 + default: &305 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -35443,7 +37128,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35465,7 +37150,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35477,16 +37162,16 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35507,7 +37192,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35556,7 +37241,7 @@ paths: type: string format: uri nullable: true - state: *283 + state: *303 examples: default: value: @@ -35566,9 +37251,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '400': description: Bad Request content: @@ -35580,7 +37265,7 @@ paths: content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35601,7 +37286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35612,7 +37297,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35634,20 +37319,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *78 - - *286 - - *287 - - *99 - - *100 + - *83 + - *306 + - *307 + - *104 + - *105 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *288 + schema: *308 - name: sort description: The property by which to sort the results. in: query @@ -35663,7 +37348,7 @@ paths: be returned. in: query required: false - schema: &525 + schema: &542 type: string description: Severity of a code scanning alert. enum: @@ -35681,13 +37366,13 @@ paths: application/json: schema: type: array - items: *289 + items: *309 examples: - default: *290 + default: *310 headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35709,7 +37394,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *78 + - *83 - name: target_type in: query description: The target type of the code security configuration @@ -35728,8 +37413,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -35737,7 +37422,7 @@ paths: application/json: schema: type: array - items: *105 + items: *110 examples: default: value: @@ -35820,7 +37505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *78 + - *83 requestBody: required: true content: @@ -35898,7 +37583,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *291 + code_scanning_options: *311 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -35907,7 +37592,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36039,9 +37724,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *105 + schema: *110 examples: - default: *292 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36063,15 +37748,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *293 + schema: *313 examples: - default: *294 + default: *314 '304': *37 '403': *29 '404': *6 @@ -36097,7 +37782,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *78 + - *83 requestBody: required: true content: @@ -36123,11 +37808,11 @@ paths: - 32 - 91 responses: - '204': *133 + '204': *143 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36149,16 +37834,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 responses: '200': description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *292 + default: *312 '304': *37 '403': *29 '404': *6 @@ -36182,8 +37867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36262,7 +37947,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36380,7 +38065,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *105 + schema: *110 examples: default: value: @@ -36439,14 +38124,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 responses: - '204': *133 + '204': *143 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36470,8 +38155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36534,8 +38219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36575,12 +38260,12 @@ paths: - none - private_and_internal - public - configuration: *105 + configuration: *110 examples: default: value: default_for_new_repos: all - configuration: *292 + configuration: *312 '403': *29 '404': *6 x-github: @@ -36604,8 +38289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -36614,8 +38299,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -36633,13 +38318,13 @@ paths: application/json: schema: type: array - items: *295 + items: *315 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *296 + repository: *316 '403': *29 '404': *6 x-github: @@ -36663,7 +38348,7 @@ paths: parameters: - *17 - *19 - - *78 + - *83 responses: '200': description: Response @@ -36679,7 +38364,7 @@ paths: type: integer codespaces: type: array - items: &347 + items: &365 type: object title: Codespace description: A codespace. @@ -36704,12 +38389,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *255 + repository: *275 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &554 + properties: &571 name: type: string description: The name of the machine. @@ -36751,7 +38436,7 @@ paths: - ready - in_progress nullable: true - required: &555 + required: &572 - name - display_name - operating_system @@ -36956,7 +38641,7 @@ paths: - pulls_url - recent_folders examples: - default: &348 + default: &366 value: total_count: 3 codespaces: @@ -37388,7 +39073,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *78 + - *83 deprecated: true requestBody: required: true @@ -37455,7 +39140,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *78 + - *83 deprecated: true requestBody: required: true @@ -37510,7 +39195,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *78 + - *83 requestBody: required: true content: @@ -37562,7 +39247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -37580,7 +39265,7 @@ paths: type: integer secrets: type: array - items: &297 + items: &317 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -37619,7 +39304,7 @@ paths: - updated_at - visibility examples: - default: &556 + default: &573 value: total_count: 2 secrets: @@ -37651,13 +39336,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &557 + schema: &574 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -37686,7 +39371,7 @@ paths: - key_id - key examples: - default: &558 + default: &575 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37709,16 +39394,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: Response content: application/json: - schema: *297 + schema: *317 examples: - default: &560 + default: &577 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -37745,8 +39430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -37801,7 +39486,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -37827,8 +39512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -37853,8 +39538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -37872,9 +39557,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 '404': *6 x-github: githubCloudOnly: false @@ -37896,8 +39581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -37947,8 +39632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -37981,8 +39666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -38021,7 +39706,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: OK @@ -38162,7 +39847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *78 + - *83 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -38185,9 +39870,9 @@ paths: currently being billed. seats: type: array - items: *124 + items: *134 examples: - default: *125 + default: *135 headers: Link: *43 '500': *40 @@ -38223,7 +39908,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38301,7 +39986,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38381,7 +40066,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38458,7 +40143,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38539,7 +40224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *78 + - *83 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -38571,13 +40256,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38599,7 +40284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -38743,7 +40428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *78 + - *83 - name: credential_id in: path required: true @@ -38774,7 +40459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response - list of custom role names @@ -38789,7 +40474,7 @@ paths: type: integer custom_roles: type: array - items: *298 + items: *318 examples: default: value: @@ -38876,12 +40561,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: &301 + schema: &321 type: object properties: name: @@ -38922,9 +40607,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -38948,8 +40633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *78 - - &300 + - *83 + - &320 name: role_id description: The unique identifier of the role. in: path @@ -38961,9 +40646,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '404': *6 x-github: githubCloudOnly: true @@ -38985,13 +40670,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: application/json: - schema: &302 + schema: &322 type: object properties: name: @@ -39029,9 +40714,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39055,8 +40740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -39084,12 +40769,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *301 + schema: *321 examples: default: value: @@ -39103,9 +40788,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39135,16 +40820,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '200': description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '404': *6 x-github: githubCloudOnly: true @@ -39172,13 +40857,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: application/json: - schema: *302 + schema: *322 examples: default: value: @@ -39193,9 +40878,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39225,8 +40910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -39254,12 +40939,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *78 - - *303 - - *304 - - *305 - - *306 - - *307 + - *83 + - *323 + - *324 + - *325 + - *326 + - *327 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -39297,13 +40982,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *308 - - *309 - - *101 - - *99 - - *100 - - *310 - - *311 + - *328 + - *329 + - *106 + - *104 + - *105 - *17 responses: '200': @@ -39312,9 +40995,9 @@ paths: application/json: schema: type: array - items: *312 + items: *330 examples: - default: *313 + default: *331 '304': *37 '400': *14 '403': *29 @@ -39340,7 +41023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -39358,7 +41041,7 @@ paths: type: integer secrets: type: array - items: &314 + items: &332 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -39429,13 +41112,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &586 + schema: &603 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -39452,7 +41135,7 @@ paths: - key_id - key examples: - default: &587 + default: &604 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39475,14 +41158,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: Response content: application/json: - schema: *314 + schema: *332 examples: default: value: @@ -39510,8 +41193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -39570,7 +41253,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -39594,8 +41277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -39619,8 +41302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -39638,9 +41321,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39661,8 +41344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -39712,8 +41395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -39744,8 +41427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -39781,8 +41464,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *78 - - &595 + - *83 + - &612 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -39790,7 +41473,7 @@ paths: required: false schema: type: string - - &596 + - &613 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -39798,7 +41481,7 @@ paths: required: false schema: type: string - - &597 + - &614 name: time_period description: |- The time period to filter by. @@ -39814,7 +41497,7 @@ paths: - week - month default: month - - &598 + - &615 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -39829,7 +41512,7 @@ paths: - denied - all default: all - - *279 + - *299 - *17 - *19 responses: @@ -39839,7 +41522,7 @@ paths: application/json: schema: type: array - items: &599 + items: &616 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -39995,7 +41678,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &600 + default: &617 value: - id: 21 number: 42 @@ -40081,12 +41764,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *78 - - *279 - - *94 - - *95 - - *96 - - &601 + - *83 + - *299 + - *99 + - *100 + - *101 + - &618 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -40112,7 +41795,7 @@ paths: application/json: schema: type: array - items: &602 + items: &619 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -40222,7 +41905,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *98 + items: *103 url: type: string format: uri @@ -40233,7 +41916,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &603 + default: &620 value: - id: 21 number: 42 @@ -40313,7 +41996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -40321,7 +42004,7 @@ paths: application/json: schema: type: array - items: &358 + items: &376 title: Package description: A software package type: object @@ -40371,8 +42054,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *315 - required: *316 + properties: *333 + required: *334 nullable: true created_at: type: string @@ -40391,7 +42074,7 @@ paths: - created_at - updated_at examples: - default: &359 + default: &377 value: - id: 197 name: hello_docker @@ -40469,7 +42152,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40479,7 +42162,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: 200-response: value: @@ -40552,7 +42235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *78 + - *83 - name: group_id description: The unique identifier of the group. in: path @@ -40578,7 +42261,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &458 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -40659,7 +42342,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &442 + default: &459 value: group_id: '123' group_name: Octocat admins @@ -40697,7 +42380,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -40714,7 +42397,7 @@ paths: description: Response content: application/json: - schema: &439 + schema: &456 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -40751,7 +42434,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &440 + default: &457 value: groups: - group_id: '123' @@ -40785,7 +42468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40795,7 +42478,7 @@ paths: application/json: schema: type: array - items: &339 + items: &357 title: Organization Invitation description: Organization Invitation type: object @@ -40842,7 +42525,7 @@ paths: - invitation_teams_url - node_id examples: - default: &340 + default: &358 value: - id: 1 login: monalisa @@ -40901,7 +42584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -40909,7 +42592,7 @@ paths: application/json: schema: type: array - items: &393 + items: &410 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -40923,7 +42606,7 @@ paths: - name - description examples: - default: &394 + default: &411 value: - name: add_assignee description: Assign or remove a user @@ -40954,7 +42637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40964,7 +42647,7 @@ paths: application/json: schema: type: array - items: &317 + items: &335 title: Org Hook description: Org Hook type: object @@ -41073,7 +42756,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *78 + - *83 requestBody: required: true content: @@ -41133,9 +42816,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: - default: &318 + default: &336 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -41179,8 +42862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *78 - - &319 + - *83 + - &337 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -41193,9 +42876,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: - default: *318 + default: *336 '404': *6 x-github: githubCloudOnly: false @@ -41216,8 +42899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 requestBody: required: false content: @@ -41262,7 +42945,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: default: value: @@ -41301,8 +42984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 responses: '204': description: Response @@ -41327,8 +43010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *78 - - *319 + - *83 + - *337 responses: '200': description: Response @@ -41356,8 +43039,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *78 - - *319 + - *83 + - *337 requestBody: required: false content: @@ -41405,10 +43088,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *17 - - *320 + - *338 responses: '200': description: Response @@ -41416,9 +43099,9 @@ paths: application/json: schema: type: array - items: *321 + items: *339 examples: - default: *322 + default: *340 '400': *14 '422': *15 x-github: @@ -41441,17 +43124,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *16 responses: '200': description: Response content: application/json: - schema: *323 + schema: *341 examples: - default: *324 + default: *342 '400': *14 '422': *15 x-github: @@ -41474,8 +43157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *16 responses: '202': *39 @@ -41501,8 +43184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 responses: '204': description: Response @@ -41524,8 +43207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *78 - - &329 + - *83 + - &347 name: actor_type in: path description: The type of the actor @@ -41538,14 +43221,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &330 + - &348 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &325 + - &343 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -41553,7 +43236,7 @@ paths: required: true schema: type: string - - &326 + - &344 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -41564,7 +43247,7 @@ paths: type: string - *19 - *17 - - *101 + - *106 - name: sort description: The property to sort the results by. in: query @@ -41646,13 +43329,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *78 - - *325 - - *326 + - *83 + - *343 + - *344 - *19 - *17 - - *101 - - &335 + - *106 + - &353 name: sort description: The property to sort the results by. in: query @@ -41730,15 +43413,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *78 - - *325 - - *326 + - *83 + - *343 + - *344 responses: '200': description: Response content: application/json: - schema: &327 + schema: &345 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -41754,7 +43437,7 @@ paths: type: integer format: int64 examples: - default: &328 + default: &346 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -41774,24 +43457,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *78 - - &331 + - *83 + - &349 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *325 - - *326 + - *343 + - *344 responses: '200': description: Response content: application/json: - schema: *327 + schema: *345 examples: - default: *328 + default: *346 x-github: enabledForGitHubApps: true category: orgs @@ -41809,19 +43492,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *78 - - *325 - - *326 - - *329 - - *330 + - *83 + - *343 + - *344 + - *347 + - *348 responses: '200': description: Response content: application/json: - schema: *327 + schema: *345 examples: - default: *328 + default: *346 x-github: enabledForGitHubApps: true category: orgs @@ -41838,10 +43521,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *78 - - *325 - - *326 - - &332 + - *83 + - *343 + - *344 + - &350 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -41854,7 +43537,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &351 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -41870,7 +43553,7 @@ paths: type: integer format: int64 examples: - default: &334 + default: &352 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -41906,19 +43589,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *78 - - *331 - - *325 - - *326 - - *332 + - *83 + - *349 + - *343 + - *344 + - *350 responses: '200': description: Response content: application/json: - schema: *333 + schema: *351 examples: - default: *334 + default: *352 x-github: enabledForGitHubApps: true category: orgs @@ -41935,20 +43618,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *78 - - *329 - - *330 - - *325 - - *326 - - *332 + - *83 + - *347 + - *348 + - *343 + - *344 + - *350 responses: '200': description: Response content: application/json: - schema: *333 + schema: *351 examples: - default: *334 + default: *352 x-github: enabledForGitHubApps: true category: orgs @@ -41965,14 +43648,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *78 - - *331 - - *325 - - *326 + - *83 + - *349 + - *343 + - *344 - *19 - *17 - - *101 - - *335 + - *106 + - *353 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -42045,7 +43728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *78 + - *83 responses: '200': description: Response @@ -42053,7 +43736,7 @@ paths: application/json: schema: *22 examples: - default: &634 + default: &651 value: id: 1 account: @@ -42122,7 +43805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -42211,7 +43894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -42219,12 +43902,12 @@ paths: application/json: schema: anyOf: - - &337 + - &355 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &336 + limit: &354 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -42249,7 +43932,7 @@ paths: properties: {} additionalProperties: false examples: - default: &338 + default: &356 value: limit: collaborators_only origin: organization @@ -42273,18 +43956,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: &635 + schema: &652 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *336 + limit: *354 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -42308,9 +43991,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: - default: *338 + default: *356 '422': *15 x-github: githubCloudOnly: false @@ -42328,7 +44011,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -42354,7 +44037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *78 + - *83 - *17 - *19 - name: role @@ -42388,9 +44071,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 '404': *6 @@ -42414,7 +44097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *78 + - *83 requestBody: required: false content: @@ -42468,7 +44151,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -42524,8 +44207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *78 - - &341 + - *83 + - &359 name: invitation_id description: The unique identifier of the invitation. in: path @@ -42558,8 +44241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *78 - - *341 + - *83 + - *359 - *17 - *19 responses: @@ -42569,9 +44252,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: &357 + default: &375 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -42606,7 +44289,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -42614,7 +44297,7 @@ paths: application/json: schema: type: array - items: *342 + items: *360 examples: default: value: @@ -42652,7 +44335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -42699,9 +44382,9 @@ paths: description: Response content: application/json: - schema: *342 + schema: *360 examples: - default: &343 + default: &361 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -42733,8 +44416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *78 - - &344 + - *83 + - &362 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -42787,9 +44470,9 @@ paths: description: Response content: application/json: - schema: *342 + schema: *360 examples: - default: *343 + default: *361 '404': *6 '422': *7 x-github: @@ -42813,8 +44496,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *78 - - *344 + - *83 + - *362 responses: '204': description: Response @@ -42847,7 +44530,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *78 + - *83 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -42877,7 +44560,7 @@ paths: - closed - all default: open - - *345 + - *363 - name: type description: Can be the name of an issue type. in: query @@ -42895,8 +44578,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -42906,9 +44589,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *346 + default: *364 headers: Link: *43 '404': *6 @@ -42930,7 +44613,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *78 + - *83 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -42968,7 +44651,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '422': *15 @@ -42988,8 +44671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response if requester is an organization member and user is @@ -43023,8 +44706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -43050,8 +44733,8 @@ paths: parameters: - *17 - *19 - - *78 - - *182 + - *83 + - *198 responses: '200': description: Response @@ -43067,9 +44750,9 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: - default: *348 + default: *366 '304': *37 '500': *40 '401': *25 @@ -43094,9 +44777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *78 - - *182 - - &349 + - *83 + - *198 + - &367 name: codespace_name in: path required: true @@ -43129,17 +44812,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *78 - - *182 - - *349 + - *83 + - *198 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: &553 + default: &570 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -43312,14 +44995,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *124 + schema: *134 examples: default: value: @@ -43388,14 +45071,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '200': description: Response content: application/json: - schema: &350 + schema: &368 title: Org Membership description: Org Membership type: object @@ -43439,7 +45122,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *64 + organization: *69 user: title: Simple User description: A GitHub user. @@ -43462,7 +45145,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &351 + response-if-user-has-an-active-admin-membership-with-organization: &369 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -43530,8 +45213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 requestBody: required: false content: @@ -43559,9 +45242,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: - response-if-user-already-had-membership-with-organization: *351 + response-if-user-already-had-membership-with-organization: *369 '422': *15 '403': *29 x-github: @@ -43585,8 +45268,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -43611,7 +45294,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *78 + - *83 - *17 - *19 - name: exclude @@ -43632,7 +45315,7 @@ paths: application/json: schema: type: array - items: &352 + items: &370 title: Migration description: A migration. type: object @@ -43673,7 +45356,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *69 + items: *74 url: type: string format: uri @@ -43885,7 +45568,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *78 + - *83 requestBody: required: true content: @@ -43961,7 +45644,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -44139,8 +45822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *78 - - &353 + - *83 + - &371 name: migration_id description: The unique identifier of the migration. in: path @@ -44167,7 +45850,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -44336,8 +46019,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *78 - - *353 + - *83 + - *371 responses: '302': description: Response @@ -44358,8 +46041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *78 - - *353 + - *83 + - *371 responses: '204': description: Response @@ -44382,9 +46065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *78 - - *353 - - &805 + - *83 + - *371 + - &824 name: repo_name description: repo_name parameter in: path @@ -44411,8 +46094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *78 - - *353 + - *83 + - *371 - *17 - *19 responses: @@ -44422,9 +46105,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: &364 + default: &382 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44563,7 +46246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -44617,7 +46300,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response - list of organization roles @@ -44633,7 +46316,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &354 + items: &372 title: Organization Role description: Organization roles type: object @@ -44793,7 +46476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *78 + - *83 requestBody: required: true content: @@ -44840,7 +46523,7 @@ paths: description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -44869,7 +46552,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -44891,8 +46574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -44917,9 +46600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *78 - - *184 - - *300 + - *83 + - *201 + - *320 responses: '204': description: Response @@ -44948,9 +46631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *78 - - *184 - - *300 + - *83 + - *201 + - *320 responses: '204': description: Response @@ -44975,8 +46658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -45001,9 +46684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *78 - - *182 - - *300 + - *83 + - *198 + - *320 responses: '204': description: Response @@ -45033,9 +46716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *78 - - *182 - - *300 + - *83 + - *198 + - *320 responses: '204': description: Response @@ -45063,14 +46746,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '200': description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -45127,8 +46810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: @@ -45167,7 +46850,7 @@ paths: description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -45195,7 +46878,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *109 + '409': *114 '404': *6 x-github: githubCloudOnly: true @@ -45220,8 +46903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -45246,8 +46929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 - *17 - *19 responses: @@ -45325,8 +47008,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 nullable: true type: description: The ownership type of the team @@ -45358,7 +47041,7 @@ paths: - type - parent examples: - default: *357 + default: *375 headers: Link: *43 '404': @@ -45387,8 +47070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 - *17 - *19 responses: @@ -45416,13 +47099,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &413 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 name: nullable: true type: string @@ -45517,7 +47200,7 @@ paths: - type - url examples: - default: *181 + default: *197 headers: Link: *43 '404': @@ -45541,7 +47224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *78 + - *83 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -45568,7 +47251,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -45593,8 +47276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *78 - - *182 + - *83 + - *198 requestBody: required: false content: @@ -45651,8 +47334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -45709,8 +47392,8 @@ paths: - docker - nuget - container - - *78 - - &807 + - *83 + - &825 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -45746,12 +47429,12 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *359 + default: *377 '403': *29 '401': *25 - '400': &809 + '400': &827 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45773,7 +47456,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &360 + - &378 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -45791,20 +47474,20 @@ paths: - docker - nuget - container - - &361 + - &379 name: package_name description: The name of the package. in: path required: true schema: type: string - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: default: value: @@ -45856,9 +47539,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 responses: '204': description: Response @@ -45890,9 +47573,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 - name: token description: package token schema: @@ -45924,9 +47607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 - *19 - *17 - name: state @@ -45946,7 +47629,7 @@ paths: application/json: schema: type: array - items: &362 + items: &380 title: Package Version description: A version of a software package type: object @@ -46071,10 +47754,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - &363 + - *378 + - *379 + - *83 + - &381 name: package_version_id description: Unique identifier of the package version. in: path @@ -46086,7 +47769,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -46122,10 +47805,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - *363 + - *378 + - *379 + - *83 + - *381 responses: '204': description: Response @@ -46157,10 +47840,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - *363 + - *378 + - *379 + - *83 + - *381 responses: '204': description: Response @@ -46187,10 +47870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *78 + - *83 - *17 - *19 - - &365 + - &383 name: sort description: The property by which to sort the results. in: query @@ -46200,8 +47883,8 @@ paths: enum: - created_at default: created_at - - *101 - - &366 + - *106 + - &384 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -46212,7 +47895,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &367 + - &385 name: repository description: The name of the repository to use to filter the results. in: query @@ -46220,7 +47903,7 @@ paths: schema: type: string example: Hello-World - - &368 + - &386 name: permission description: The permission to use to filter the results. in: query @@ -46228,7 +47911,7 @@ paths: schema: type: string example: issues_read - - &369 + - &387 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -46238,7 +47921,7 @@ paths: schema: type: string format: date-time - - &370 + - &388 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -46248,7 +47931,7 @@ paths: schema: type: string format: date-time - - &371 + - &389 name: token_id description: The ID of the token in: query @@ -46412,7 +48095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *78 + - *83 requestBody: required: true content: @@ -46478,7 +48161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *78 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -46518,7 +48201,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46539,7 +48222,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *78 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -46559,9 +48242,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -46584,17 +48267,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *78 + - *83 - *17 - *19 - - *365 - - *101 - - *366 - - *367 - - *368 - - *369 - - *370 - - *371 + - *383 + - *106 + - *384 + - *385 + - *386 + - *387 + - *388 + - *389 responses: '500': *40 '422': *15 @@ -46743,7 +48426,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *78 + - *83 requestBody: required: true content: @@ -46803,7 +48486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *78 + - *83 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -46833,7 +48516,7 @@ paths: responses: '500': *40 '404': *6 - '204': *133 + '204': *143 '403': *29 '422': *15 x-github: @@ -46855,7 +48538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *78 + - *83 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -46874,9 +48557,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -46900,7 +48583,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -46918,7 +48601,7 @@ paths: type: integer configurations: type: array - items: &372 + items: &390 title: Organization private registry description: Private registry configuration for an organization type: object @@ -47006,7 +48689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -47171,7 +48854,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &373 + org-private-registry-with-selected-visibility: &391 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -47212,7 +48895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -47260,16 +48943,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 '404': *6 x-github: githubCloudOnly: false @@ -47290,8 +48973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -47386,8 +49069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -47412,7 +49095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *78 + - *83 - name: state description: Indicates the state of the projects to return. in: query @@ -47433,7 +49116,7 @@ paths: application/json: schema: type: array - items: &374 + items: &392 title: Project description: Projects are a way to organize columns and cards of work. @@ -47580,7 +49263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *78 + - *83 requestBody: required: true content: @@ -47606,7 +49289,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: default: value: @@ -47644,7 +49327,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &457 + '410': &474 description: Gone content: application/json: @@ -47670,15 +49353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *78 + - *83 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *99 - - *100 + - *104 + - *105 - *17 responses: '200': @@ -47687,7 +49370,7 @@ paths: application/json: schema: type: array - items: &375 + items: &393 title: Projects v2 Project description: A projects v2 project type: object @@ -47757,7 +49440,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &885 + properties: &903 id: type: number description: The unique identifier of the status update. @@ -47805,7 +49488,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &886 + required: &904 - id - node_id - created_at @@ -47830,7 +49513,7 @@ paths: - deleted_at - deleted_by examples: - default: &376 + default: &394 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -47933,22 +49616,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &377 + - &395 name: project_number description: The project's number. in: path required: true schema: type: integer - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *375 + schema: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -47970,11 +49653,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *377 - - *78 + - *395 + - *83 - *17 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -47982,7 +49665,7 @@ paths: application/json: schema: type: array - items: &378 + items: &396 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -48129,7 +49812,7 @@ paths: - updated_at - project_url examples: - default: &379 + default: &397 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48172,23 +49855,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *377 - - &826 + - *395 + - &844 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *378 + schema: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -48211,8 +49894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *377 - - *78 + - *395 + - *83 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -48221,18 +49904,21 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 - - *99 - - *100 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - *104 + - *105 - *17 responses: '200': @@ -48241,7 +49927,7 @@ paths: application/json: schema: type: array - items: &385 + items: &403 title: Projects v2 Item description: An item belonging to a project type: object @@ -48257,7 +49943,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &383 + content_type: &401 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -48307,7 +49993,7 @@ paths: - updated_at - archived_at examples: - default: &386 + default: &404 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -49001,8 +50687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *78 - - *377 + - *83 + - *395 requestBody: required: true description: Details of the item to add to the project. @@ -49039,7 +50725,7 @@ paths: description: Response content: application/json: - schema: &827 + schema: &845 title: Projects v2 Item description: An item belonging to a project type: object @@ -49052,8 +50738,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *189 - - &568 + - *206 + - &585 title: Pull Request Simple description: Pull Request Simple type: object @@ -49159,8 +50845,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true active_lock_reason: type: string @@ -49205,7 +50891,7 @@ paths: nullable: true requested_teams: type: array - items: *282 + items: *302 nullable: true head: type: object @@ -49214,7 +50900,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: @@ -49237,7 +50923,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: @@ -49256,7 +50942,7 @@ paths: _links: type: object properties: - comments: &382 + comments: &400 title: Link description: Hypermedia Link type: object @@ -49265,13 +50951,13 @@ paths: type: string required: - href - commits: *382 - statuses: *382 - html: *382 - issue: *382 - review_comments: *382 - review_comment: *382 - self: *382 + commits: *400 + statuses: *400 + html: *400 + issue: *400 + review_comments: *400 + review_comment: *400 + self: *400 required: - comments - commits @@ -49281,8 +50967,8 @@ paths: - review_comments - review_comment - self - author_association: *190 - auto_merge: &679 + author_association: *207 + auto_merge: &698 title: Auto merge description: The status of auto merging a pull request. type: object @@ -49384,7 +51070,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *383 + content_type: *401 creator: *4 created_at: type: string @@ -49417,7 +51103,7 @@ paths: - updated_at - archived_at examples: - issue: &384 + issue: &402 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -49472,7 +51158,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *384 + pull_request: *402 '304': *37 '403': *29 '401': *25 @@ -49492,9 +51178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *377 - - *78 - - &387 + - *395 + - *83 + - &405 name: item_id description: The unique identifier of the project item. in: path @@ -49502,24 +51188,27 @@ paths: schema: type: integer - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *385 + schema: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -49540,9 +51229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *377 - - *78 - - *387 + - *395 + - *83 + - *405 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -49612,13 +51301,13 @@ paths: description: Response content: application/json: - schema: *385 + schema: *403 examples: - text_field: *386 - number_field: *386 - date_field: *386 - single_select_field: *386 - iteration_field: *386 + text_field: *404 + number_field: *404 + date_field: *404 + single_select_field: *404 + iteration_field: *404 '401': *25 '403': *29 '404': *6 @@ -49638,9 +51327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *377 - - *78 - - *387 + - *395 + - *83 + - *405 responses: '204': description: Response @@ -49664,7 +51353,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -49672,9 +51361,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -49701,7 +51390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -49712,7 +51401,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *129 + items: *145 minItems: 1 maxItems: 100 required: @@ -49742,9 +51431,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -49765,16 +51454,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -49797,13 +51486,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 requestBody: required: true content: application/json: - schema: *388 + schema: *406 examples: default: value: @@ -49819,9 +51508,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -49844,10 +51533,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 responses: - '204': *133 + '204': *143 '403': *29 '404': *6 x-github: @@ -49868,7 +51557,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *78 + - *83 - *17 - *19 - name: repository_query @@ -49906,25 +51595,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &389 - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value + items: *144 description: List of custom property names and associated values required: - repository_id @@ -49973,7 +51644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *78 + - *83 requestBody: required: true content: @@ -49993,7 +51664,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *389 + items: *144 required: - repository_names - properties @@ -50034,7 +51705,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *78 + - *83 - *17 - *19 responses: @@ -50046,7 +51717,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -50065,8 +51736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response if user is a public member @@ -50090,8 +51761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -50112,8 +51783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -50137,7 +51808,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *78 + - *83 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -50184,9 +51855,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -50207,7 +51878,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *78 + - *83 requestBody: required: true content: @@ -50389,7 +52060,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &476 title: Full Repository description: Full Repository type: object @@ -50666,8 +52337,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *390 - required: *391 + properties: *407 + required: *408 nullable: true temp_clone_token: type: string @@ -50754,8 +52425,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true organization: title: Simple User @@ -50764,8 +52435,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *69 - source: *69 + parent: *74 + source: *74 forks: type: integer master_branch: @@ -50782,7 +52453,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &573 + properties: &590 url: type: string format: uri @@ -50798,12 +52469,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &574 + required: &591 - url - key - name - html_url - security_and_analysis: *392 + security_and_analysis: *409 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -50887,7 +52558,7 @@ paths: - network_count - subscribers_count examples: - default: &461 + default: &478 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -51405,7 +53076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -51413,9 +53084,9 @@ paths: application/json: schema: type: array - items: *393 + items: *410 examples: - default: *394 + default: *411 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -51437,10 +53108,10 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - *17 - *19 - - &702 + - &721 name: targets description: | A comma-separated list of rule targets to filter by. @@ -51458,7 +53129,7 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: default: value: @@ -51505,7 +53176,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 requestBody: description: Request body required: true @@ -51526,40 +53197,40 @@ paths: - push - repository default: branch - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *395 + items: *157 + conditions: *412 rules: type: array description: An array of rules within the ruleset. - items: &397 + items: &414 title: Repository Rule type: object description: A repository rule. oneOf: - - *142 - - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - *158 - *159 - *160 - *161 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - *174 + - *175 + - *176 + - *177 required: - name - enforcement @@ -51597,9 +53268,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: &396 + default: &413 value: id: 21 name: super cool ruleset @@ -51653,8 +53324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *78 - - &704 + - *83 + - &723 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -51664,16 +53335,16 @@ paths: schema: type: string x-multi-segment: true - - *279 - - *96 - - &705 + - *299 + - *101 + - &724 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &706 + - &725 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51693,7 +53364,7 @@ paths: description: Response content: application/json: - schema: &707 + schema: &726 title: Rule Suites description: Response type: array @@ -51748,7 +53419,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &708 + default: &727 value: - id: 21 actor_id: 12 @@ -51791,8 +53462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *78 - - &709 + - *83 + - &728 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51808,7 +53479,7 @@ paths: description: Response content: application/json: - schema: &710 + schema: &729 title: Rule Suite description: Response type: object @@ -51907,7 +53578,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &711 + default: &730 value: id: 21 actor_id: 12 @@ -51968,7 +53639,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -51980,9 +53651,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *396 + default: *413 '404': *6 '500': *40 put: @@ -52000,7 +53671,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52026,16 +53697,16 @@ paths: - tag - push - repository - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *395 + items: *157 + conditions: *412 rules: description: An array of rules within the ruleset. type: array - items: *397 + items: *414 examples: default: value: @@ -52070,9 +53741,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *396 + default: *413 '404': *6 '500': *40 delete: @@ -52090,7 +53761,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52113,7 +53784,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *78 + - *83 - *17 - *19 - name: ruleset_id @@ -52129,9 +53800,9 @@ paths: application/json: schema: type: array - items: *166 + items: *182 examples: - default: *398 + default: *415 '404': *6 '500': *40 x-github: @@ -52150,7 +53821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52168,7 +53839,7 @@ paths: description: Response content: application/json: - schema: *399 + schema: *416 examples: default: value: @@ -52230,15 +53901,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *78 - - *400 - - *401 - - *402 - - *403 - - *101 + - *83 + - *417 + - *418 + - *419 + - *420 + - *106 - *19 - *17 - - &713 + - &732 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -52248,7 +53919,7 @@ paths: required: false schema: type: string - - &714 + - &733 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -52258,10 +53929,10 @@ paths: required: false schema: type: string - - *404 - - *405 - - *406 - - *407 + - *421 + - *422 + - *423 + - *424 responses: '200': description: Response @@ -52269,13 +53940,13 @@ paths: application/json: schema: type: array - items: *408 + items: *425 examples: - default: *409 + default: *426 headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52300,15 +53971,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *410 + schema: *427 examples: - default: *411 + default: *428 '403': *29 '404': *6 patch: @@ -52329,7 +54000,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *78 + - *83 requestBody: required: true content: @@ -52337,7 +54008,7 @@ paths: schema: type: object properties: - pattern_config_version: *169 + pattern_config_version: *185 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -52363,7 +54034,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *169 + custom_pattern_version: *185 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -52399,7 +54070,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 "/orgs/{org}/security-advisories": get: @@ -52417,8 +54088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *78 - - *101 + - *83 + - *106 - name: sort description: The property to sort the results by. in: query @@ -52430,8 +54101,8 @@ paths: - updated - published default: created - - *99 - - *100 + - *104 + - *105 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -52461,7 +54132,7 @@ paths: application/json: schema: type: array - items: &735 + items: &754 description: A repository security advisory. type: object properties: @@ -52648,7 +54319,7 @@ paths: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array nullable: true @@ -52681,7 +54352,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 credits_detailed: type: array nullable: true @@ -52691,7 +54362,7 @@ paths: type: object properties: user: *4 - type: *412 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -52715,14 +54386,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *282 + items: *302 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *110 + - *115 required: - ghsa_id - cve_id @@ -52752,7 +54423,7 @@ paths: - private_fork additionalProperties: false examples: - default: &736 + default: &755 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -53131,7 +54802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *78 + - *83 responses: '200': description: Response @@ -53139,9 +54810,9 @@ paths: application/json: schema: type: array - items: *413 + items: *430 examples: - default: *357 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53164,8 +54835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -53190,8 +54861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -53220,15 +54891,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *414 + schema: *431 examples: - default: *415 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53252,8 +54923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *78 - - *416 + - *83 + - *433 - *17 - *19 responses: @@ -53261,9 +54932,9 @@ paths: description: Success content: application/json: - schema: *417 + schema: *434 examples: - default: *418 + default: *435 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -53285,15 +54956,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53315,15 +54986,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *421 + schema: *438 examples: - default: *422 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53343,7 +55014,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Immutable releases settings response @@ -53392,7 +55063,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -53449,7 +55120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *78 + - *83 - *19 - *17 responses: @@ -53467,9 +55138,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53488,7 +55159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *78 + - *83 requestBody: required: true content: @@ -53537,8 +55208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -53560,8 +55231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -53584,7 +55255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -53602,9 +55273,9 @@ paths: type: integer network_configurations: type: array - items: *126 + items: *136 examples: - default: *423 + default: *440 headers: Link: *43 x-github: @@ -53625,7 +55296,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -53667,9 +55338,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53689,16 +55360,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 - - *128 + - *83 + - *138 responses: '200': description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 headers: Link: *43 x-github: @@ -53719,8 +55390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 - - *128 + - *83 + - *138 requestBody: required: true content: @@ -53759,9 +55430,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53780,8 +55451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *78 - - *128 + - *83 + - *138 responses: '204': description: Response @@ -53804,16 +55475,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *78 - - *424 + - *83 + - *441 responses: '200': description: Response content: application/json: - schema: *425 + schema: *442 examples: - default: *426 + default: *443 headers: Link: *43 x-github: @@ -53832,7 +55503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -53851,7 +55522,7 @@ paths: description: Response content: application/json: - schema: &448 + schema: &465 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -53897,7 +55568,7 @@ paths: type: string nullable: true examples: - default: &449 + default: &466 value: groups: - group_id: '123' @@ -53942,8 +55613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -53975,13 +55646,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53999,7 +55670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *78 + - *83 - *17 - *19 responses: @@ -54009,9 +55680,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 headers: Link: *43 '403': *29 @@ -54033,7 +55704,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *78 + - *83 requestBody: required: true content: @@ -54105,7 +55776,7 @@ paths: description: Response content: application/json: - schema: &427 + schema: &444 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -54168,8 +55839,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 nullable: true members_count: type: integer @@ -54432,7 +56103,7 @@ paths: - repos_count - organization examples: - default: &428 + default: &445 value: id: 1 node_id: MDQ6VGVhbTE= @@ -54502,16 +56173,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 x-github: githubCloudOnly: false @@ -54532,8 +56203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: false content: @@ -54595,16 +56266,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '201': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 '422': *15 '403': *29 @@ -54629,8 +56300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -54656,9 +56327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *78 - - *184 - - *101 + - *83 + - *201 + - *106 - *17 - *19 - name: pinned @@ -54674,7 +56345,7 @@ paths: application/json: schema: type: array - items: &429 + items: &446 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -54753,7 +56424,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *191 + reactions: *208 required: - author - body @@ -54773,7 +56444,7 @@ paths: - updated_at - url examples: - default: &779 + default: &798 value: - author: login: octocat @@ -54847,8 +56518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -54882,9 +56553,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: &430 + default: &447 value: author: login: octocat @@ -54956,9 +56627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *78 - - *184 - - &431 + - *83 + - *201 + - &448 name: discussion_number description: The number that identifies the discussion. in: path @@ -54970,9 +56641,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54994,9 +56665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: false content: @@ -55019,9 +56690,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: &780 + default: &799 value: author: login: octocat @@ -55091,9 +56762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 responses: '204': description: Response @@ -55119,10 +56790,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *78 - - *184 - - *431 - - *101 + - *83 + - *201 + - *448 + - *106 - *17 - *19 responses: @@ -55132,7 +56803,7 @@ paths: application/json: schema: type: array - items: &432 + items: &449 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -55189,7 +56860,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *191 + reactions: *208 required: - author - body @@ -55204,7 +56875,7 @@ paths: - updated_at - url examples: - default: &781 + default: &800 value: - author: login: octocat @@ -55272,9 +56943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: true content: @@ -55296,9 +56967,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: &433 + default: &450 value: author: login: octocat @@ -55364,10 +57035,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - &434 + - *83 + - *201 + - *448 + - &451 name: comment_number description: The number that identifies the comment. in: path @@ -55379,9 +57050,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55403,10 +57074,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 requestBody: required: true content: @@ -55428,9 +57099,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: &782 + default: &801 value: author: login: octocat @@ -55494,10 +57165,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 responses: '204': description: Response @@ -55523,10 +57194,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -55552,7 +57223,7 @@ paths: application/json: schema: type: array - items: &435 + items: &452 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -55595,7 +57266,7 @@ paths: - content - created_at examples: - default: &437 + default: &454 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -55645,10 +57316,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 requestBody: required: true content: @@ -55681,9 +57352,9 @@ paths: team discussion comment content: application/json: - schema: *435 + schema: *452 examples: - default: &436 + default: &453 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -55712,9 +57383,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55737,11 +57408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *78 - - *184 - - *431 - - *434 - - &438 + - *83 + - *201 + - *448 + - *451 + - &455 name: reaction_id description: The unique identifier of the reaction. in: path @@ -55773,9 +57444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -55801,9 +57472,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -55829,9 +57500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: true content: @@ -55863,16 +57534,16 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55895,10 +57566,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *78 - - *184 - - *431 - - *438 + - *83 + - *201 + - *448 + - *455 responses: '204': description: Response @@ -55921,16 +57592,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *439 + schema: *456 examples: - default: *440 + default: *457 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55949,8 +57620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -55973,9 +57644,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *458 examples: - default: *442 + default: *459 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -55994,8 +57665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -56019,8 +57690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56030,9 +57701,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 x-github: @@ -56054,8 +57725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *78 - - *184 + - *83 + - *201 - name: role description: Filters members returned by their role in the team. in: query @@ -56078,7 +57749,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -56108,15 +57779,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 responses: '200': description: Response content: application/json: - schema: &443 + schema: &460 title: Team Membership description: Team Membership type: object @@ -56143,7 +57814,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &783 + response-if-user-is-a-team-maintainer: &802 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56179,9 +57850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 requestBody: required: false content: @@ -56206,9 +57877,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-users-membership-with-team-is-now-pending: &784 + response-if-users-membership-with-team-is-now-pending: &803 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56243,9 +57914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 responses: '204': description: Response @@ -56270,8 +57941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56281,7 +57952,7 @@ paths: application/json: schema: type: array - items: &444 + items: &461 title: Team Project description: A team's access to a project. type: object @@ -56349,7 +58020,7 @@ paths: - updated_at - permissions examples: - default: &785 + default: &804 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -56412,9 +58083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *78 - - *184 - - &445 + - *83 + - *201 + - &462 name: project_id description: The unique identifier of the project. in: path @@ -56426,9 +58097,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *461 examples: - default: &786 + default: &805 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -56490,9 +58161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *78 - - *184 - - *445 + - *83 + - *201 + - *462 requestBody: required: false content: @@ -56558,9 +58229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *78 - - *184 - - *445 + - *83 + - *201 + - *462 responses: '204': description: Response @@ -56587,8 +58258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56598,9 +58269,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -56629,16 +58300,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &787 + schema: &806 title: Team Repository description: A team's access to a repository. type: object @@ -56661,8 +58332,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true forks: type: integer @@ -57207,10 +58878,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 requestBody: required: false content: @@ -57255,10 +58926,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 responses: '204': description: Response @@ -57284,16 +58955,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *448 + schema: *465 examples: - default: *449 + default: *466 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57315,8 +58986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -57359,7 +59030,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *465 examples: default: value: @@ -57391,8 +59062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -57402,9 +59073,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - response-if-child-teams-exist: &788 + response-if-child-teams-exist: &807 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -57457,7 +59128,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *78 + - *83 - name: security_product in: path description: The security feature to enable or disable. @@ -57531,7 +59202,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &450 + - &467 name: card_id description: The unique identifier of the card. in: path @@ -57543,7 +59214,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &468 title: Project Card description: Project cards represent a scope of work. type: object @@ -57610,7 +59281,7 @@ paths: - created_at - updated_at examples: - default: &452 + default: &469 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -57666,7 +59337,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *450 + - *467 requestBody: required: false content: @@ -57693,9 +59364,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 '304': *37 '403': *29 '401': *25 @@ -57722,7 +59393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *450 + - *467 responses: '204': description: Response @@ -57766,7 +59437,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *450 + - *467 requestBody: required: true content: @@ -57877,7 +59548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &453 + - &470 name: column_id description: The unique identifier of the column. in: path @@ -57889,7 +59560,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &471 title: Project Column description: Project columns contain cards of work. type: object @@ -57935,7 +59606,7 @@ paths: - created_at - updated_at examples: - default: &455 + default: &472 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -57970,7 +59641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *453 + - *470 requestBody: required: true content: @@ -57994,9 +59665,9 @@ paths: description: Response content: application/json: - schema: *454 + schema: *471 examples: - default: *455 + default: *472 '304': *37 '403': *29 '401': *25 @@ -58021,7 +59692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *453 + - *470 responses: '204': description: Response @@ -58050,7 +59721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *453 + - *470 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -58071,7 +59742,7 @@ paths: application/json: schema: type: array - items: *451 + items: *468 examples: default: value: @@ -58130,7 +59801,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *453 + - *470 requestBody: required: true content: @@ -58170,9 +59841,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 '304': *37 '403': *29 '401': *25 @@ -58182,8 +59853,8 @@ paths: application/json: schema: oneOf: - - *232 - - *233 + - *250 + - *251 '503': description: Response content: @@ -58228,7 +59899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *453 + - *470 requestBody: required: true content: @@ -58288,15 +59959,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *445 + - *462 responses: '200': description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: &456 + default: &473 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -58353,7 +60024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *445 + - *462 requestBody: required: false content: @@ -58399,9 +60070,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: *456 + default: *473 '404': description: Not Found if the authenticated user does not have access to the project @@ -58422,7 +60093,7 @@ paths: items: type: string '401': *25 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -58445,7 +60116,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *445 + - *462 responses: '204': description: Delete Success @@ -58466,7 +60137,7 @@ paths: items: type: string '401': *25 - '410': *457 + '410': *474 '404': *6 x-github: githubCloudOnly: false @@ -58490,7 +60161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *445 + - *462 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -58517,7 +60188,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -58547,8 +60218,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *445 - - *182 + - *462 + - *198 requestBody: required: false content: @@ -58600,8 +60271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *445 - - *182 + - *462 + - *198 responses: '204': description: Response @@ -58632,8 +60303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *445 - - *182 + - *462 + - *198 responses: '200': description: Response @@ -58706,7 +60377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *445 + - *462 - *17 - *19 responses: @@ -58716,7 +60387,7 @@ paths: application/json: schema: type: array - items: *454 + items: *471 examples: default: value: @@ -58754,7 +60425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *445 + - *462 requestBody: required: true content: @@ -58777,7 +60448,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *471 examples: default: value: @@ -58842,7 +60513,7 @@ paths: resources: type: object properties: - core: &458 + core: &475 title: Rate Limit type: object properties: @@ -58859,21 +60530,21 @@ paths: - remaining - reset - used - graphql: *458 - search: *458 - code_search: *458 - source_import: *458 - integration_manifest: *458 - code_scanning_upload: *458 - actions_runner_registration: *458 - scim: *458 - dependency_snapshots: *458 - dependency_sbom: *458 - code_scanning_autofix: *458 + graphql: *475 + search: *475 + code_search: *475 + source_import: *475 + integration_manifest: *475 + code_scanning_upload: *475 + actions_runner_registration: *475 + scim: *475 + dependency_snapshots: *475 + dependency_sbom: *475 + code_scanning_autofix: *475 required: - core - search - rate: *458 + rate: *475 required: - rate - resources @@ -58978,14 +60649,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: default-response: summary: Default response @@ -59490,7 +61161,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *460 + '301': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59508,8 +61179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -59766,10 +61437,10 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 - '307': &462 + default: *478 + '307': &479 description: Temporary Redirect content: application/json: @@ -59798,8 +61469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -59821,9 +61492,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *462 + '307': *479 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59845,11 +61516,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - - &477 + - &494 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -59872,7 +61543,7 @@ paths: type: integer artifacts: type: array - items: &463 + items: &480 title: Artifact description: An artifact type: object @@ -59950,7 +61621,7 @@ paths: - expires_at - updated_at examples: - default: &478 + default: &495 value: total_count: 2 artifacts: @@ -60011,9 +61682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *446 - - *447 - - &464 + - *463 + - *464 + - &481 name: artifact_id description: The unique identifier of the artifact. in: path @@ -60025,7 +61696,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *480 examples: default: value: @@ -60063,9 +61734,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *446 - - *447 + - *463 - *464 + - *481 responses: '204': description: Response @@ -60089,9 +61760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *446 - - *447 + - *463 - *464 + - *481 - name: archive_format in: path required: true @@ -60105,7 +61776,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60128,14 +61799,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *465 + schema: *482 examples: default: value: @@ -60161,11 +61832,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - - &466 + - &483 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -60193,13 +61864,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *101 + - *106 responses: '200': description: Response content: application/json: - schema: &467 + schema: &484 title: Repository actions caches description: Repository actions caches type: object @@ -60241,7 +61912,7 @@ paths: - total_count - actions_caches examples: - default: &468 + default: &485 value: total_count: 1 actions_caches: @@ -60273,23 +61944,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *446 - - *447 + - *463 + - *464 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *466 + - *483 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: *468 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60309,8 +61980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *446 - - *447 + - *463 + - *464 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -60341,9 +62012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *446 - - *447 - - &469 + - *463 + - *464 + - &486 name: job_id description: The unique identifier of the job. in: path @@ -60355,7 +62026,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &498 title: Job description: Information of a job execution in a workflow run type: object @@ -60662,9 +62333,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *446 - - *447 - - *469 + - *463 + - *464 + - *486 responses: '302': description: Response @@ -60692,9 +62363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *446 - - *447 - - *469 + - *463 + - *464 + - *486 requestBody: required: false content: @@ -60715,7 +62386,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -60739,8 +62410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Status response @@ -60790,8 +62461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -60825,7 +62496,7 @@ paths: description: Empty response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -60854,8 +62525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -60873,7 +62544,7 @@ paths: type: integer secrets: type: array - items: &483 + items: &500 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -60893,7 +62564,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &501 value: total_count: 2 secrets: @@ -60926,9 +62597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *446 - - *447 - - *470 + - *463 + - *464 + - *487 - *19 responses: '200': @@ -60945,7 +62616,7 @@ paths: type: integer variables: type: array - items: &487 + items: &504 title: Actions Variable type: object properties: @@ -60975,7 +62646,7 @@ paths: - created_at - updated_at examples: - default: &488 + default: &505 value: total_count: 2 variables: @@ -61008,8 +62679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -61018,12 +62689,12 @@ paths: schema: type: object properties: - enabled: &471 + enabled: &488 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *51 - selected_actions_url: *242 - sha_pinning_required: *52 + allowed_actions: *56 + selected_actions_url: *262 + sha_pinning_required: *57 required: - enabled examples: @@ -61053,8 +62724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61065,9 +62736,9 @@ paths: schema: type: object properties: - enabled: *471 - allowed_actions: *51 - sha_pinning_required: *52 + enabled: *488 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled examples: @@ -61098,14 +62769,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &472 + schema: &489 type: object properties: access_level: @@ -61123,7 +62794,7 @@ paths: required: - access_level examples: - default: &473 + default: &490 value: access_level: organization x-github: @@ -61148,15 +62819,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *472 + schema: *489 examples: - default: *473 + default: *490 responses: '204': description: Response @@ -61180,14 +62851,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: default: value: @@ -61211,8 +62882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Empty response for successful settings update @@ -61222,7 +62893,7 @@ paths: required: true content: application/json: - schema: *245 + schema: *265 examples: default: summary: Set retention days @@ -61246,16 +62917,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *53 + schema: *58 examples: - default: *246 + default: *266 '404': *6 x-github: enabledForGitHubApps: true @@ -61274,8 +62945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61285,7 +62956,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -61309,16 +62980,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *247 + schema: *267 examples: - default: *54 + default: *59 '403': *29 '404': *6 x-github: @@ -61338,15 +63009,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *248 + schema: *268 examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -61370,16 +63041,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *56 + schema: *61 examples: - default: *57 + default: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61402,8 +63073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61411,9 +63082,9 @@ paths: required: false content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61435,16 +63106,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *251 + schema: *271 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61465,8 +63136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Success response @@ -61477,9 +63148,9 @@ paths: required: true content: application/json: - schema: *252 + schema: *272 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61506,8 +63177,8 @@ paths: in: query schema: type: string - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -61525,9 +63196,9 @@ paths: type: integer runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -61551,8 +63222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -61560,9 +63231,9 @@ paths: application/json: schema: type: array - items: *256 + items: *276 examples: - default: *257 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61584,8 +63255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -61628,10 +63299,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *278 '404': *6 '422': *7 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61659,16 +63330,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *259 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61696,16 +63367,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61727,17 +63398,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: *261 + default: *281 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61758,9 +63429,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: '204': description: Response @@ -61786,11 +63457,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: - '200': *72 + '200': *77 '404': *6 x-github: githubCloudOnly: false @@ -61812,9 +63483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 requestBody: required: true content: @@ -61838,7 +63509,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61862,9 +63533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 requestBody: required: true content: @@ -61889,7 +63560,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61913,11 +63584,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: - '200': *262 + '200': *282 '404': *6 x-github: githubCloudOnly: false @@ -61944,12 +63615,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 - - *263 + - *463 + - *464 + - *71 + - *283 responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61975,9 +63646,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *446 - - *447 - - &491 + - *463 + - *464 + - &508 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -61985,7 +63656,7 @@ paths: required: false schema: type: string - - &492 + - &509 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -61993,7 +63664,7 @@ paths: required: false schema: type: string - - &493 + - &510 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -62002,7 +63673,7 @@ paths: required: false schema: type: string - - &494 + - &511 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -62029,7 +63700,7 @@ paths: - pending - *17 - *19 - - &495 + - &512 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -62038,7 +63709,7 @@ paths: schema: type: string format: date-time - - &474 + - &491 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -62047,13 +63718,13 @@ paths: schema: type: boolean default: false - - &496 + - &513 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &497 + - &514 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -62076,7 +63747,7 @@ paths: type: integer workflow_runs: type: array - items: &475 + items: &492 title: Workflow Run description: An invocation of a workflow type: object @@ -62171,7 +63842,7 @@ paths: that triggered the run. type: array nullable: true - items: *194 + items: *211 created_at: type: string format: date-time @@ -62224,7 +63895,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &519 + properties: &536 id: type: string description: SHA for the commit @@ -62275,7 +63946,7 @@ paths: - name - email nullable: true - required: &520 + required: &537 - id - tree_id - message @@ -62283,8 +63954,8 @@ paths: - author - committer nullable: true - repository: *255 - head_repository: *255 + repository: *275 + head_repository: *275 head_repository_id: type: integer example: 5 @@ -62322,7 +63993,7 @@ paths: - workflow_url - pull_requests examples: - default: &498 + default: &515 value: total_count: 1 workflow_runs: @@ -62558,24 +64229,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *446 - - *447 - - &476 + - *463 + - *464 + - &493 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *474 + - *491 responses: '200': description: Response content: application/json: - schema: *475 + schema: *492 examples: - default: &479 + default: &496 value: id: 30433642 name: Build @@ -62816,9 +64487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '204': description: Response @@ -62841,9 +64512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -62962,15 +64633,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -62997,12 +64668,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 - *17 - *19 - - *477 + - *494 responses: '200': description: Response @@ -63018,9 +64689,9 @@ paths: type: integer artifacts: type: array - items: *463 + items: *480 examples: - default: *478 + default: *495 headers: Link: *43 x-github: @@ -63044,25 +64715,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *446 - - *447 - - *476 - - &480 + - *463 + - *464 + - *493 + - &497 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *474 + - *491 responses: '200': description: Response content: application/json: - schema: *475 + schema: *492 examples: - default: *479 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63085,10 +64756,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *446 - - *447 - - *476 - - *480 + - *463 + - *464 + - *493 + - *497 - *17 - *19 responses: @@ -63106,9 +64777,9 @@ paths: type: integer jobs: type: array - items: *481 + items: *498 examples: - default: &482 + default: &499 value: total_count: 1 jobs: @@ -63221,10 +64892,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *446 - - *447 - - *476 - - *480 + - *463 + - *464 + - *493 + - *497 responses: '302': description: Response @@ -63252,19 +64923,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '202': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63287,9 +64958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: true content: @@ -63356,19 +65027,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '202': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63391,9 +65062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -63423,9 +65094,9 @@ paths: type: integer jobs: type: array - items: *481 + items: *498 examples: - default: *482 + default: *499 headers: Link: *43 x-github: @@ -63450,9 +65121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '302': description: Response @@ -63479,9 +65150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '204': description: Response @@ -63508,9 +65179,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -63570,7 +65241,7 @@ paths: items: type: object properties: - type: &604 + type: &621 type: string description: The type of reviewer. enum: @@ -63580,7 +65251,7 @@ paths: reviewer: anyOf: - *4 - - *282 + - *302 required: - environment - wait_timer @@ -63655,9 +65326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: true content: @@ -63704,7 +65375,7 @@ paths: application/json: schema: type: array - items: &590 + items: &607 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -63792,8 +65463,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -63810,7 +65481,7 @@ paths: - created_at - updated_at examples: - default: &591 + default: &608 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -63866,9 +65537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: false content: @@ -63889,7 +65560,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -63912,9 +65583,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: false content: @@ -63935,7 +65606,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -63968,9 +65639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -64107,8 +65778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -64126,9 +65797,9 @@ paths: type: integer secrets: type: array - items: *483 + items: *500 examples: - default: *484 + default: *501 headers: Link: *43 x-github: @@ -64153,16 +65824,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *485 + schema: *502 examples: - default: *486 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64184,17 +65855,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *500 examples: - default: &617 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -64220,9 +65891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -64253,7 +65924,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -64279,9 +65950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -64306,9 +65977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *446 - - *447 - - *470 + - *463 + - *464 + - *487 - *19 responses: '200': @@ -64325,9 +65996,9 @@ paths: type: integer variables: type: array - items: *487 + items: *504 examples: - default: *488 + default: *505 headers: Link: *43 x-github: @@ -64350,8 +66021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -64378,7 +66049,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -64403,17 +66074,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 responses: '200': description: Response content: application/json: - schema: *487 + schema: *504 examples: - default: &618 + default: &635 value: name: USERNAME value: octocat @@ -64439,9 +66110,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 requestBody: required: true content: @@ -64483,9 +66154,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 responses: '204': description: Response @@ -64510,8 +66181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -64529,7 +66200,7 @@ paths: type: integer workflows: type: array - items: &489 + items: &506 title: Workflow description: A GitHub Actions workflow type: object @@ -64636,9 +66307,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *446 - - *447 - - &490 + - *463 + - *464 + - &507 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -64653,7 +66324,7 @@ paths: description: Response content: application/json: - schema: *489 + schema: *506 examples: default: value: @@ -64686,9 +66357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64713,9 +66384,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64766,9 +66437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64795,19 +66466,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *446 - - *447 - - *490 - - *491 - - *492 - - *493 - - *494 + - *463 + - *464 + - *507 + - *508 + - *509 + - *510 + - *511 - *17 - *19 - - *495 - - *474 - - *496 - - *497 + - *512 + - *491 + - *513 + - *514 responses: '200': description: Response @@ -64823,9 +66494,9 @@ paths: type: integer workflow_runs: type: array - items: *475 + items: *492 examples: - default: *498 + default: *515 headers: Link: *43 x-github: @@ -64858,9 +66529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '200': description: Response @@ -64921,12 +66592,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *446 - - *447 - - *101 + - *463 + - *464 + - *106 - *17 - - *99 - - *100 + - *104 + - *105 - name: ref description: |- The Git reference for the activities you want to list. @@ -65086,8 +66757,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -65099,7 +66770,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -65124,8 +66795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *446 - - *447 + - *463 + - *464 - name: assignee in: path required: true @@ -65161,8 +66832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -65274,11 +66945,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *446 - - *447 + - *463 + - *464 - *17 - - *99 - - *100 + - *104 + - *105 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -65331,7 +67002,7 @@ paths: initiator: type: string examples: - default: *499 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65351,8 +67022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -65360,7 +67031,7 @@ paths: application/json: schema: type: array - items: &500 + items: &517 title: Autolink reference description: An autolink reference. type: object @@ -65414,8 +67085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -65454,9 +67125,9 @@ paths: description: response content: application/json: - schema: *500 + schema: *517 examples: - default: &501 + default: &518 value: id: 1 key_prefix: TICKET- @@ -65487,9 +67158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *446 - - *447 - - &502 + - *463 + - *464 + - &519 name: autolink_id description: The unique identifier of the autolink. in: path @@ -65501,9 +67172,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: *501 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -65523,9 +67194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *446 - - *447 - - *502 + - *463 + - *464 + - *519 responses: '204': description: Response @@ -65549,8 +67220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response if Dependabot is enabled @@ -65598,8 +67269,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -65620,8 +67291,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -65641,8 +67312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *446 - - *447 + - *463 + - *464 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -65680,7 +67351,7 @@ paths: - url protected: type: boolean - protection: &504 + protection: &521 title: Branch Protection description: Branch Protection type: object @@ -65722,7 +67393,7 @@ paths: required: - contexts - checks - enforce_admins: &507 + enforce_admins: &524 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -65737,7 +67408,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &509 + required_pull_request_reviews: &526 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -65758,7 +67429,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *282 + items: *302 apps: description: The list of apps with review dismissal access. @@ -65787,7 +67458,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *282 + items: *302 apps: description: The list of apps allowed to bypass pull request requirements. @@ -65813,7 +67484,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &506 + restrictions: &523 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -65876,7 +67547,7 @@ paths: type: string teams: type: array - items: *282 + items: *302 apps: type: array items: @@ -66090,9 +67761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *446 - - *447 - - &505 + - *463 + - *464 + - &522 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -66106,14 +67777,14 @@ paths: description: Response content: application/json: - schema: &515 + schema: &532 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &564 + commit: &581 title: Commit description: Commit type: object @@ -66147,7 +67818,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &503 + properties: &520 name: type: string example: '"Chris Wanstrath"' @@ -66162,7 +67833,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true message: type: string @@ -66183,7 +67854,7 @@ paths: required: - sha - url - verification: &624 + verification: &641 title: Verification type: object properties: @@ -66217,12 +67888,12 @@ paths: nullable: true oneOf: - *4 - - *266 + - *286 committer: nullable: true oneOf: - *4 - - *266 + - *286 parents: type: array items: @@ -66253,7 +67924,7 @@ paths: type: integer files: type: array - items: &577 + items: &594 title: Diff Entry description: Diff Entry type: object @@ -66337,7 +68008,7 @@ paths: - self protected: type: boolean - protection: *504 + protection: *521 protection_url: type: string format: uri @@ -66444,7 +68115,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *460 + '301': *477 '404': *6 x-github: githubCloudOnly: false @@ -66466,15 +68137,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *504 + schema: *521 examples: default: value: @@ -66668,9 +68339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -66925,7 +68596,7 @@ paths: url: type: string format: uri - required_status_checks: &512 + required_status_checks: &529 title: Status Check Policy description: Status Check Policy type: object @@ -67001,7 +68672,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 apps: type: array items: *5 @@ -67019,7 +68690,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 apps: type: array items: *5 @@ -67077,7 +68748,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *506 + restrictions: *523 required_conversation_resolution: type: object properties: @@ -67189,9 +68860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67216,17 +68887,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: &508 + default: &525 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -67248,17 +68919,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: *508 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67277,9 +68948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67304,17 +68975,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *509 + schema: *526 examples: - default: &510 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -67410,9 +69081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67510,9 +69181,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *526 examples: - default: *510 + default: *527 '422': *15 x-github: githubCloudOnly: false @@ -67533,9 +69204,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67562,17 +69233,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: &511 + default: &528 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -67595,17 +69266,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: *511 + default: *528 '404': *6 x-github: githubCloudOnly: false @@ -67625,9 +69296,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67652,17 +69323,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *512 + schema: *529 examples: - default: &513 + default: &530 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -67688,9 +69359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67742,9 +69413,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *529 examples: - default: *513 + default: *530 '404': *6 '422': *15 x-github: @@ -67766,9 +69437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67792,9 +69463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -67828,9 +69499,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67897,9 +69568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67963,9 +69634,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: content: application/json: @@ -68031,15 +69702,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *506 + schema: *523 examples: default: value: @@ -68130,9 +69801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -68155,9 +69826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68167,7 +69838,7 @@ paths: type: array items: *5 examples: - default: &514 + default: &531 value: - id: 1 slug: octoapp @@ -68224,9 +69895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68260,7 +69931,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68281,9 +69952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68317,7 +69988,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68338,9 +70009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68374,7 +70045,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68396,9 +70067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68406,9 +70077,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '404': *6 x-github: githubCloudOnly: false @@ -68428,9 +70099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -68466,9 +70137,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68489,9 +70160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -68527,9 +70198,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68550,9 +70221,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: content: application/json: @@ -68587,9 +70258,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68611,9 +70282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68623,7 +70294,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '404': *6 x-github: githubCloudOnly: false @@ -68647,9 +70318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68682,7 +70353,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68707,9 +70378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68742,7 +70413,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68767,9 +70438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68802,7 +70473,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68829,9 +70500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68853,7 +70524,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *532 examples: default: value: @@ -68967,12 +70638,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *97 + - *463 + - *464 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -68982,9 +70653,9 @@ paths: application/json: schema: type: array - items: *277 + items: *297 examples: - default: *278 + default: *298 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -69004,8 +70675,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69019,7 +70690,7 @@ paths: description: Response content: application/json: - schema: *277 + schema: *297 examples: default: value: @@ -69078,12 +70749,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *97 + - *463 + - *464 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -69093,9 +70764,9 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 '404': *6 '403': *29 '500': *40 @@ -69119,8 +70790,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69132,7 +70803,7 @@ paths: description: A single bypass request. content: application/json: - schema: *280 + schema: *300 examples: default: value: @@ -69190,8 +70861,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69262,8 +70933,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_response_id in: path required: true @@ -69296,8 +70967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -69576,7 +71247,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &533 title: CheckRun description: A check performed on the code of a given code change type: object @@ -69687,16 +71358,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *194 - deployment: &843 + items: *211 + deployment: &861 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -69763,8 +71434,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -69976,9 +71647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *446 - - *447 - - &517 + - *463 + - *464 + - &534 name: check_run_id description: The unique identifier of the check run. in: path @@ -69990,9 +71661,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *533 examples: - default: &518 + default: &535 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -70092,9 +71763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 requestBody: required: true content: @@ -70334,9 +72005,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *533 examples: - default: *518 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70356,9 +72027,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 - *17 - *19 responses: @@ -70453,15 +72124,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -70499,8 +72170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -70522,7 +72193,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &521 + schema: &538 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -70586,7 +72257,7 @@ paths: nullable: true pull_requests: type: array - items: *194 + items: *211 nullable: true app: title: GitHub app @@ -70597,9 +72268,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - repository: *255 + properties: *203 + required: *204 + repository: *275 created_at: type: string format: date-time @@ -70608,12 +72279,12 @@ paths: type: string format: date-time nullable: true - head_commit: &869 + head_commit: &887 title: Simple Commit description: A commit. type: object - properties: *519 - required: *520 + properties: *536 + required: *537 latest_check_runs_count: type: integer check_runs_url: @@ -70641,7 +72312,7 @@ paths: - check_runs_url - pull_requests examples: - default: &522 + default: &539 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -70932,9 +72603,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *521 + schema: *538 examples: - default: *522 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70953,8 +72624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -71015,7 +72686,7 @@ paths: required: - app_id - setting - repository: *255 + repository: *275 examples: default: value: @@ -71263,9 +72934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *446 - - *447 - - &523 + - *463 + - *464 + - &540 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -71277,9 +72948,9 @@ paths: description: Response content: application/json: - schema: *521 + schema: *538 examples: - default: *522 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71302,17 +72973,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *446 - - *447 - - *523 - - &570 + - *463 + - *464 + - *540 + - &587 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &571 + - &588 name: status description: Returns check runs with the specified `status`. in: query @@ -71351,9 +73022,9 @@ paths: type: integer check_runs: type: array - items: *516 + items: *533 examples: - default: &572 + default: &589 value: total_count: 1 check_runs: @@ -71455,15 +73126,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *446 - - *447 - - *523 + - *463 + - *464 + - *540 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -71490,30 +73161,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *446 - - *447 - - *286 - - *287 + - *463 + - *464 + - *306 + - *307 - *19 - *17 - - &539 + - &556 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *524 - - &540 + schema: *541 + - &557 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *101 - - *99 - - *100 + - *106 + - *104 + - *105 - name: sort description: The property by which to sort the results. in: query @@ -71529,13 +73200,13 @@ paths: be returned. in: query required: false - schema: *288 + schema: *308 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *525 + schema: *542 responses: '200': description: Response @@ -71546,14 +73217,14 @@ paths: items: type: object properties: - number: *113 - created_at: *120 - updated_at: *121 - url: *118 - html_url: *119 - instances_url: *526 - state: *104 - fixed_at: *123 + number: *123 + created_at: *130 + updated_at: *131 + url: *128 + html_url: *129 + instances_url: *543 + state: *109 + fixed_at: *133 dismissed_by: title: Simple User description: A GitHub user. @@ -71561,12 +73232,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *122 - dismissed_reason: *527 - dismissed_comment: *528 - rule: *529 - tool: *530 - most_recent_instance: *531 + dismissed_at: *132 + dismissed_reason: *544 + dismissed_comment: *545 + rule: *546 + tool: *547 + most_recent_instance: *548 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71692,14 +73363,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &532 + '403': &549 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71719,9 +73390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *446 - - *447 - - &533 + - *463 + - *464 + - &550 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -71729,23 +73400,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *113 + schema: *123 responses: '200': description: Response content: application/json: - schema: &534 + schema: &551 type: object properties: - number: *113 - created_at: *120 - updated_at: *121 - url: *118 - html_url: *119 - instances_url: *526 - state: *104 - fixed_at: *123 + number: *123 + created_at: *130 + updated_at: *131 + url: *128 + html_url: *129 + instances_url: *543 + state: *109 + fixed_at: *133 dismissed_by: title: Simple User description: A GitHub user. @@ -71753,9 +73424,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *122 - dismissed_reason: *527 - dismissed_comment: *528 + dismissed_at: *132 + dismissed_reason: *544 + dismissed_comment: *545 rule: type: object properties: @@ -71809,8 +73480,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *530 - most_recent_instance: *531 + tool: *547 + most_recent_instance: *548 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71909,9 +73580,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71929,9 +73600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: true content: @@ -71946,8 +73617,8 @@ paths: enum: - open - dismissed - dismissed_reason: *527 - dismissed_comment: *528 + dismissed_reason: *544 + dismissed_comment: *545 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -71966,7 +73637,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *551 examples: default: value: @@ -72042,14 +73713,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &538 + '403': &555 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72069,15 +73740,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 responses: '200': description: Response content: application/json: - schema: &535 + schema: &552 type: object properties: status: @@ -72103,13 +73774,13 @@ paths: - description - started_at examples: - default: &536 + default: &553 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &537 + '400': &554 description: Bad Request content: application/json: @@ -72120,9 +73791,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72145,29 +73816,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 responses: '200': description: OK content: application/json: - schema: *535 + schema: *552 examples: - default: *536 + default: *553 '202': description: Accepted content: application/json: - schema: *535 + schema: *552 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *537 + '400': *554 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -72177,7 +73848,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72199,9 +73870,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: false content: @@ -72246,12 +73917,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *537 - '403': *538 + '400': *554 + '403': *555 '404': *6 '422': description: Unprocessable Entity - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72271,13 +73942,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 - *19 - *17 - - *539 - - *540 + - *556 + - *557 responses: '200': description: Response @@ -72285,7 +73956,7 @@ paths: application/json: schema: type: array - items: *531 + items: *548 examples: default: value: @@ -72324,9 +73995,9 @@ paths: end_column: 50 classifications: - source - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72358,29 +74029,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *446 - - *447 - - *286 - - *287 + - *463 + - *464 + - *306 + - *307 - *19 - *17 - - *540 + - *557 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *524 + schema: *541 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &543 + schema: &560 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *101 + - *106 - name: sort description: The property by which to sort the results. in: query @@ -72397,23 +74068,23 @@ paths: application/json: schema: type: array - items: &544 + items: &561 type: object properties: - ref: *524 - commit_sha: &552 + ref: *541 + commit_sha: &569 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *541 + analysis_key: *558 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *542 + category: *559 error: type: string example: error reading field xyz @@ -72437,8 +74108,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *543 - tool: *530 + sarif_id: *560 + tool: *547 deletable: type: boolean warning: @@ -72499,9 +74170,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72535,8 +74206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -72549,7 +74220,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: response: summary: application/json response @@ -72603,14 +74274,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *532 + '403': *549 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72690,8 +74361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -72744,9 +74415,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *538 + '403': *555 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72766,8 +74437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -72775,7 +74446,7 @@ paths: application/json: schema: type: array - items: &545 + items: &562 title: CodeQL Database description: A CodeQL database. type: object @@ -72886,9 +74557,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72915,8 +74586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: language in: path description: The language of the CodeQL database. @@ -72928,7 +74599,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *562 examples: default: value: @@ -72960,11 +74631,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &579 + '302': &596 description: Found - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72984,8 +74655,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *446 - - *447 + - *463 + - *464 - name: language in: path description: The language of the CodeQL database. @@ -72995,9 +74666,9 @@ paths: responses: '204': description: Response - '403': *538 + '403': *555 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73023,8 +74694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73033,7 +74704,7 @@ paths: type: object additionalProperties: false properties: - language: &546 + language: &563 type: string description: The language targeted by the CodeQL query enum: @@ -73112,7 +74783,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &550 + schema: &567 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -73120,9 +74791,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *110 + controller_repo: *115 actor: *4 - query_language: *546 + query_language: *563 query_pack_url: type: string description: The download url for the query pack. @@ -73169,7 +74840,7 @@ paths: items: type: object properties: - repository: &547 + repository: &564 title: Repository Identifier description: Repository Identifier type: object @@ -73205,7 +74876,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &551 + analysis_status: &568 type: string description: The new status of the CodeQL variant analysis repository task. @@ -73237,7 +74908,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &548 + access_mismatch_repos: &565 type: object properties: repository_count: @@ -73251,7 +74922,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *547 + items: *564 required: - repository_count - repositories @@ -73273,8 +74944,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *548 - over_limit_repos: *548 + no_codeql_db_repos: *565 + over_limit_repos: *565 required: - access_mismatch_repos - not_found_repos @@ -73290,7 +74961,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &549 + value: &566 summary: Default response value: id: 1 @@ -73442,17 +75113,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *549 + value: *566 repository_lists: summary: Response for a successful variant analysis submission - value: *549 + value: *566 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73473,8 +75144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *446 - - *447 + - *463 + - *464 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -73486,11 +75157,11 @@ paths: description: Response content: application/json: - schema: *550 + schema: *567 examples: - default: *549 + default: *566 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73511,7 +75182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *446 + - *463 - name: repo in: path description: The name of the controller repository. @@ -73545,8 +75216,8 @@ paths: schema: type: object properties: - repository: *110 - analysis_status: *551 + repository: *115 + analysis_status: *568 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -73650,7 +75321,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73671,8 +75342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -73757,9 +75428,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73778,8 +75449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73846,7 +75517,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -73871,7 +75542,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *538 + '403': *555 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -73885,7 +75556,7 @@ paths: content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73942,8 +75613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73951,7 +75622,7 @@ paths: schema: type: object properties: - commit_sha: *552 + commit_sha: *569 ref: type: string description: |- @@ -74009,7 +75680,7 @@ paths: schema: type: object properties: - id: *543 + id: *560 url: type: string description: The REST API URL for checking the status of the upload. @@ -74023,11 +75694,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *538 + '403': *555 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74046,8 +75717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *446 - - *447 + - *463 + - *464 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -74093,10 +75764,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *532 + '403': *549 '404': description: Not Found if the sarif id does not match any upload - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74118,8 +75789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74143,7 +75814,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *105 + configuration: *110 examples: default: value: @@ -74175,7 +75846,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *133 + '204': *143 '304': *37 '403': *29 '404': *6 @@ -74200,8 +75871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -74321,8 +75992,8 @@ paths: parameters: - *17 - *19 - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74338,7 +76009,7 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: default: value: @@ -74636,8 +76307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -74700,22 +76371,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -74739,8 +76410,8 @@ paths: parameters: - *17 - *19 - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74804,8 +76475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -74840,14 +76511,14 @@ paths: type: integer machines: type: array - items: &795 + items: &814 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *554 - required: *555 + properties: *571 + required: *572 examples: - default: &796 + default: &815 value: total_count: 2 machines: @@ -74887,8 +76558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -74972,8 +76643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -75018,7 +76689,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,8 +76710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -75058,7 +76729,7 @@ paths: type: integer secrets: type: array - items: &559 + items: &576 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -75078,7 +76749,7 @@ paths: - created_at - updated_at examples: - default: *556 + default: *573 headers: Link: *43 x-github: @@ -75101,16 +76772,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *557 + schema: *574 examples: - default: *558 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75130,17 +76801,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *559 + schema: *576 examples: - default: *560 + default: *577 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,9 +76831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -75190,7 +76861,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -75214,9 +76885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -75244,8 +76915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *446 - - *447 + - *463 + - *464 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -75287,7 +76958,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &561 + properties: &578 login: type: string example: octocat @@ -75380,7 +77051,7 @@ paths: user_view_type: type: string example: public - required: &562 + required: &579 - avatar_url - events_url - followers_url @@ -75454,9 +77125,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '204': description: Response if user is a collaborator @@ -75502,9 +77173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 requestBody: required: false content: @@ -75530,7 +77201,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &637 + schema: &654 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -75541,7 +77212,7 @@ paths: example: 42 type: integer format: int64 - repository: *255 + repository: *275 invitee: title: Simple User description: A GitHub user. @@ -75719,7 +77390,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *232 + schema: *250 '403': *29 x-github: triggersNotification: true @@ -75759,9 +77430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '204': description: No Content when collaborator was removed from the repository. @@ -75792,9 +77463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '200': description: if user has admin permissions @@ -75814,8 +77485,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *561 - required: *562 + properties: *578 + required: *579 nullable: true required: - permission @@ -75870,8 +77541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -75881,7 +77552,7 @@ paths: application/json: schema: type: array - items: &563 + items: &580 title: Commit Comment description: Commit Comment type: object @@ -75922,8 +77593,8 @@ paths: updated_at: type: string format: date-time - author_association: *190 - reactions: *191 + author_association: *207 + reactions: *208 required: - url - html_url @@ -75939,7 +77610,7 @@ paths: - created_at - updated_at examples: - default: &566 + default: &583 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75998,17 +77669,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *563 + schema: *580 examples: - default: &567 + default: &584 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76065,9 +77736,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -76089,7 +77760,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -76140,9 +77811,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -76163,9 +77834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -76191,9 +77862,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -76214,9 +77885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -76248,16 +77919,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -76279,10 +77950,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -76331,8 +78002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *446 - - *447 + - *463 + - *464 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -76388,9 +78059,9 @@ paths: application/json: schema: type: array - items: *564 + items: *581 examples: - default: &686 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -76464,7 +78135,7 @@ paths: '500': *40 '400': *14 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76484,9 +78155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *446 - - *447 - - &565 + - *463 + - *464 + - &582 name: commit_sha description: The SHA of the commit. in: path @@ -76533,7 +78204,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76558,9 +78229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 - *17 - *19 responses: @@ -76570,9 +78241,9 @@ paths: application/json: schema: type: array - items: *563 + items: *580 examples: - default: *566 + default: *583 headers: Link: *43 x-github: @@ -76600,9 +78271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 requestBody: required: true content: @@ -76637,9 +78308,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: - default: *567 + default: *584 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76667,9 +78338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 - *17 - *19 responses: @@ -76679,9 +78350,9 @@ paths: application/json: schema: type: array - items: *568 + items: *585 examples: - default: &678 + default: &697 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -77161,7 +78832,7 @@ paths: draft: false headers: Link: *43 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77218,11 +78889,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 - - &569 + - &586 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -77237,9 +78908,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *581 examples: - default: &665 + default: &682 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77326,8 +78997,8 @@ paths: '422': *15 '404': *6 '500': *40 - '503': *167 - '409': *109 + '503': *183 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77352,11 +79023,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *446 - - *447 - - *569 - - *570 - - *571 + - *463 + - *464 + - *586 + - *587 + - *588 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -77390,9 +79061,9 @@ paths: type: integer check_runs: type: array - items: *516 + items: *533 examples: - default: *572 + default: *589 headers: Link: *43 x-github: @@ -77417,9 +79088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -77427,7 +79098,7 @@ paths: schema: type: integer example: 1 - - *570 + - *587 - *17 - *19 responses: @@ -77445,7 +79116,7 @@ paths: type: integer check_suites: type: array - items: *521 + items: *538 examples: default: value: @@ -77645,9 +79316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - *17 - *19 responses: @@ -77714,7 +79385,7 @@ paths: type: string total_count: type: integer - repository: *255 + repository: *275 commit_url: type: string format: uri @@ -77845,9 +79516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - *17 - *19 responses: @@ -77857,7 +79528,7 @@ paths: application/json: schema: type: array - items: &740 + items: &759 title: Status description: The status of a commit. type: object @@ -77938,7 +79609,7 @@ paths: site_admin: false headers: Link: *43 - '301': *460 + '301': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77966,8 +79637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -77996,20 +79667,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *573 - required: *574 + properties: *590 + required: *591 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &575 + properties: &592 url: type: string format: uri html_url: type: string format: uri - required: &576 + required: &593 - url - html_url nullable: true @@ -78017,32 +79688,32 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true contributing: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true readme: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true issue_template: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true pull_request_template: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true required: - code_of_conduct @@ -78169,8 +79840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 - name: basehead @@ -78213,8 +79884,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *564 - merge_base_commit: *564 + base_commit: *581 + merge_base_commit: *581 status: type: string enum: @@ -78234,10 +79905,10 @@ paths: example: 6 commits: type: array - items: *564 + items: *581 files: type: array - items: *577 + items: *594 required: - url - html_url @@ -78481,7 +80152,7 @@ paths: module Test" '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78523,8 +80194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -78667,7 +80338,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &578 + response-if-content-is-a-file: &595 summary: Response if content is a file value: type: file @@ -78799,7 +80470,7 @@ paths: - size - type - url - - &691 + - &710 title: Content File description: Content File type: object @@ -79000,7 +80671,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *578 + response-if-content-is-a-file: *595 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -79069,7 +80740,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *579 + '302': *596 '304': *37 x-github: githubCloudOnly: false @@ -79092,8 +80763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -79186,7 +80857,7 @@ paths: description: Response content: application/json: - schema: &580 + schema: &597 title: File Commit description: File Commit type: object @@ -79338,7 +81009,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *597 examples: example-for-creating-a-file: value: @@ -79392,7 +81063,7 @@ paths: schema: oneOf: - *3 - - &619 + - &636 description: Repository rule violation was detected type: object properties: @@ -79413,7 +81084,7 @@ paths: items: type: object properties: - placeholder_id: &732 + placeholder_id: &751 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -79445,8 +81116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -79507,7 +81178,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *597 examples: default: value: @@ -79541,8 +81212,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *109 - '503': *167 + '409': *114 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79562,8 +81233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *446 - - *447 + - *463 + - *464 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -79686,31 +81357,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *446 - - *447 - - *303 - - *304 - - *305 - - *306 + - *463 + - *464 + - *323 + - *324 + - *325 + - *326 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *307 - - *581 - - *308 - - *309 - - *101 - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 + - *327 + - *598 + - *328 + - *329 + - *106 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -79719,10 +81382,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 - - *310 - - *311 + - *104 + - *105 responses: '200': description: Response @@ -79730,11 +81391,11 @@ paths: application/json: schema: type: array - items: &584 + items: &601 type: object description: A Dependabot alert. properties: - number: *113 + number: *123 state: type: string description: The state of the Dependabot alert. @@ -79749,7 +81410,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *114 + package: *124 manifest_path: type: string description: The full path to the dependency manifest file, @@ -79776,13 +81437,13 @@ paths: - unknown - direct - transitive - security_advisory: *582 - security_vulnerability: *117 - url: *118 - html_url: *119 - created_at: *120 - updated_at: *121 - dismissed_at: *122 + security_advisory: *599 + security_vulnerability: *127 + url: *128 + html_url: *129 + created_at: *130 + updated_at: *131 + dismissed_at: *132 dismissed_by: title: Simple User description: A GitHub user. @@ -79806,8 +81467,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *123 - auto_dismissed_at: *583 + fixed_at: *133 + auto_dismissed_at: *600 required: - number - state @@ -80037,9 +81698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *446 - - *447 - - &585 + - *463 + - *464 + - &602 name: alert_number in: path description: |- @@ -80048,13 +81709,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *113 + schema: *123 responses: '200': description: Response content: application/json: - schema: *584 + schema: *601 examples: default: value: @@ -80167,9 +81828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *446 - - *447 - - *585 + - *463 + - *464 + - *602 requestBody: required: true content: @@ -80214,7 +81875,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: default: value: @@ -80320,7 +81981,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *7 x-github: githubCloudOnly: false @@ -80343,8 +82004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -80362,7 +82023,7 @@ paths: type: integer secrets: type: array - items: &588 + items: &605 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -80415,16 +82076,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *586 + schema: *603 examples: - default: *587 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80444,15 +82105,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *588 + schema: *605 examples: default: value: @@ -80478,9 +82139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -80508,7 +82169,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -80532,9 +82193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -80556,8 +82217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *446 - - *447 + - *463 + - *464 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -80717,8 +82378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -80957,8 +82618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -81033,7 +82694,7 @@ paths: - version - url additionalProperties: false - metadata: &589 + metadata: &606 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -81066,7 +82727,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *589 + metadata: *606 resolved: type: object description: A collection of resolved package dependencies. @@ -81079,7 +82740,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *589 + metadata: *606 relationship: type: string description: A notation of whether a dependency is requested @@ -81208,8 +82869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *446 - - *447 + - *463 + - *464 - name: sha description: The SHA recorded at creation time. in: query @@ -81249,9 +82910,9 @@ paths: application/json: schema: type: array - items: *590 + items: *607 examples: - default: *591 + default: *608 headers: Link: *43 x-github: @@ -81317,8 +82978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -81399,7 +83060,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *607 examples: simple-example: summary: Simple example @@ -81472,9 +83133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *446 - - *447 - - &592 + - *463 + - *464 + - &609 name: deployment_id description: deployment_id parameter in: path @@ -81486,7 +83147,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *607 examples: default: value: @@ -81551,9 +83212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 responses: '204': description: Response @@ -81575,9 +83236,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 - *17 - *19 responses: @@ -81587,7 +83248,7 @@ paths: application/json: schema: type: array - items: &593 + items: &610 title: Deployment Status description: The status of a deployment. type: object @@ -81678,8 +83339,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -81748,9 +83409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 requestBody: required: true content: @@ -81825,9 +83486,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *610 examples: - default: &594 + default: &611 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -81883,9 +83544,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 - name: status_id in: path required: true @@ -81896,9 +83557,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *610 examples: - default: *594 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -81925,12 +83586,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 - - *595 - - *596 - - *597 - - *598 + - *463 + - *464 + - *612 + - *613 + - *614 + - *615 - *17 - *19 responses: @@ -81940,9 +83601,9 @@ paths: application/json: schema: type: array - items: *599 + items: *616 examples: - default: *600 + default: *617 '404': *6 '403': *29 '500': *40 @@ -81966,8 +83627,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -81979,7 +83640,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *599 + schema: *616 examples: default: value: @@ -82035,8 +83696,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82095,12 +83756,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *601 + - *463 + - *464 + - *99 + - *100 + - *101 + - *618 - *17 - *19 responses: @@ -82110,9 +83771,9 @@ paths: application/json: schema: type: array - items: *602 + items: *619 examples: - default: *603 + default: *620 '404': *6 '403': *29 '500': *40 @@ -82137,8 +83798,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82150,7 +83811,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *602 + schema: *619 examples: default: value: @@ -82208,8 +83869,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82278,8 +83939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -82336,8 +83997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -82354,7 +84015,7 @@ paths: type: integer environments: type: array - items: &605 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -82406,7 +84067,7 @@ paths: type: type: string example: wait_timer - wait_timer: &607 + wait_timer: &624 type: integer example: 30 description: The amount of time to delay a job after @@ -82443,11 +84104,11 @@ paths: items: type: object properties: - type: *604 + type: *621 reviewer: anyOf: - *4 - - *282 + - *302 required: - id - node_id @@ -82467,7 +84128,7 @@ paths: - id - node_id - type - deployment_branch_policy: &608 + deployment_branch_policy: &625 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -82583,9 +84244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *446 - - *447 - - &606 + - *463 + - *464 + - &623 name: environment_name in: path required: true @@ -82598,9 +84259,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *622 examples: - default: &609 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -82684,9 +84345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: false content: @@ -82695,7 +84356,7 @@ paths: type: object nullable: true properties: - wait_timer: *607 + wait_timer: *624 prevent_self_review: type: boolean example: false @@ -82712,13 +84373,13 @@ paths: items: type: object properties: - type: *604 + type: *621 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *608 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -82738,9 +84399,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *622 examples: - default: *609 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -82764,9 +84425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 responses: '204': description: Default response @@ -82791,9 +84452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 - *17 - *19 responses: @@ -82811,7 +84472,7 @@ paths: example: 2 branch_policies: type: array - items: &610 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -82868,9 +84529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: true content: @@ -82916,9 +84577,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - example-wildcard: &611 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -82960,10 +84621,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - &612 + - *463 + - *464 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -82975,9 +84636,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - default: *611 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82996,10 +84657,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - *612 + - *463 + - *464 + - *623 + - *629 requestBody: required: true content: @@ -83027,9 +84688,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - default: *611 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83048,10 +84709,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - *612 + - *463 + - *464 + - *623 + - *629 responses: '204': description: Response @@ -83076,9 +84737,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 responses: '200': description: List of deployment protection rules @@ -83094,7 +84755,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &613 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -83113,7 +84774,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &614 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -83212,9 +84873,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 requestBody: content: application/json: @@ -83235,9 +84896,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *613 + schema: *630 examples: - default: &615 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -83272,9 +84933,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 - *19 - *17 responses: @@ -83293,7 +84954,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *614 + items: *631 examples: default: value: @@ -83328,10 +84989,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *446 - - *447 - - *606 - - &616 + - *463 + - *464 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -83343,9 +85004,9 @@ paths: description: Response content: application/json: - schema: *613 + schema: *630 examples: - default: *615 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83366,10 +85027,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *606 - - *447 - - *446 - - *616 + - *623 + - *464 + - *463 + - *633 responses: '204': description: Response @@ -83395,9 +85056,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 - *17 - *19 responses: @@ -83415,9 +85076,9 @@ paths: type: integer secrets: type: array - items: *483 + items: *500 examples: - default: *484 + default: *501 headers: Link: *43 x-github: @@ -83442,17 +85103,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 responses: '200': description: Response content: application/json: - schema: *485 + schema: *502 examples: - default: *486 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83474,18 +85135,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *500 examples: - default: *617 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83507,10 +85168,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 requestBody: required: true content: @@ -83541,7 +85202,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -83567,10 +85228,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 responses: '204': description: Default response @@ -83595,10 +85256,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *446 - - *447 - - *606 - - *470 + - *463 + - *464 + - *623 + - *487 - *19 responses: '200': @@ -83615,9 +85276,9 @@ paths: type: integer variables: type: array - items: *487 + items: *504 examples: - default: *488 + default: *505 headers: Link: *43 x-github: @@ -83640,9 +85301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: true content: @@ -83669,7 +85330,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -83694,18 +85355,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *446 - - *447 - - *606 - - *268 + - *463 + - *464 + - *623 + - *288 responses: '200': description: Response content: application/json: - schema: *487 + schema: *504 examples: - default: *618 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83726,10 +85387,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *446 - - *447 - - *268 - - *606 + - *463 + - *464 + - *288 + - *623 requestBody: required: true content: @@ -83771,10 +85432,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *446 - - *447 - - *268 - - *606 + - *463 + - *464 + - *288 + - *623 responses: '204': description: Response @@ -83796,8 +85457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -83807,7 +85468,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: 200-response: value: @@ -83865,8 +85526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *446 - - *447 + - *463 + - *464 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -83888,7 +85549,7 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: default: value: @@ -84025,8 +85686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -84058,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 '400': *14 '422': *15 '403': *29 @@ -84081,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84133,7 +85794,7 @@ paths: schema: type: string '404': *6 - '409': *109 + '409': *114 '403': *29 '422': description: Validation failed @@ -84141,8 +85802,8 @@ paths: application/json: schema: oneOf: - - *232 - - *619 + - *250 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84167,8 +85828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *446 - - *447 + - *463 + - *464 - name: file_sha in: path required: true @@ -84219,7 +85880,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84267,8 +85928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84377,7 +86038,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -84541,7 +86202,7 @@ paths: type: string '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84591,15 +86252,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 responses: '200': description: Response content: application/json: - schema: *620 + schema: *637 examples: default: value: @@ -84630,7 +86291,7 @@ paths: payload: verified_at: '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84655,9 +86316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *446 - - *447 - - &621 + - *463 + - *464 + - &638 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -84674,7 +86335,7 @@ paths: application/json: schema: type: array - items: &622 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -84728,7 +86389,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *43 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84749,17 +86410,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 responses: '200': description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: &623 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -84769,7 +86430,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84788,8 +86449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84818,16 +86479,16 @@ paths: description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: *623 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84846,9 +86507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 requestBody: required: true content: @@ -84877,11 +86538,11 @@ paths: description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: *623 + default: *640 '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84897,16 +86558,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84954,8 +86615,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -85022,7 +86683,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -85073,7 +86734,7 @@ paths: - sha - type - url - verification: *624 + verification: *641 required: - sha - url @@ -85083,7 +86744,7 @@ paths: - tag - message examples: - default: &626 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -85110,7 +86771,7 @@ paths: schema: type: string '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85156,8 +86817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *446 - - *447 + - *463 + - *464 - name: tag_sha in: path required: true @@ -85168,11 +86829,11 @@ paths: description: Response content: application/json: - schema: *625 + schema: *642 examples: - default: *626 + default: *643 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85194,8 +86855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -85268,7 +86929,7 @@ paths: description: Response content: application/json: - schema: &627 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -85341,7 +87002,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85364,8 +87025,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *446 - - *447 + - *463 + - *464 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -85388,7 +87049,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *644 examples: default-response: summary: Default response @@ -85429,7 +87090,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85447,8 +87108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -85458,7 +87119,7 @@ paths: application/json: schema: type: array - items: &628 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -85512,7 +87173,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &877 + last_response: &895 title: Hook Response type: object properties: @@ -85586,8 +87247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -85639,9 +87300,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: &629 + default: &646 value: type: Repository id: 12345678 @@ -85689,17 +87350,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '200': description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: *629 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -85719,9 +87380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 requestBody: required: true content: @@ -85766,9 +87427,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: *629 + default: *646 '422': *15 '404': *6 x-github: @@ -85789,9 +87450,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -85815,9 +87476,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '200': description: Response @@ -85844,9 +87505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 requestBody: required: false content: @@ -85890,11 +87551,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *17 - - *320 + - *338 responses: '200': description: Response @@ -85902,9 +87563,9 @@ paths: application/json: schema: type: array - items: *321 + items: *339 examples: - default: *322 + default: *340 '400': *14 '422': *15 x-github: @@ -85923,18 +87584,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *16 responses: '200': description: Response content: application/json: - schema: *323 + schema: *341 examples: - default: *324 + default: *342 '400': *14 '422': *15 x-github: @@ -85953,9 +87614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *16 responses: '202': *39 @@ -85978,9 +87639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -86005,9 +87666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -86030,8 +87691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response if immutable releases are enabled @@ -86077,11 +87738,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 - '409': *109 + '204': *143 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86098,11 +87759,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 - '409': *109 + '204': *143 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86156,14 +87817,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &630 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -86262,7 +87923,7 @@ paths: - html_url - authors_url examples: - default: &633 + default: &650 value: vcs: subversion use_lfs: true @@ -86278,7 +87939,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &631 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -86307,8 +87968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -86356,7 +88017,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: default: value: @@ -86381,7 +88042,7 @@ paths: type: string '422': *15 '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86409,8 +88070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -86459,7 +88120,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: example-1: summary: Example 1 @@ -86507,7 +88168,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86530,12 +88191,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86561,9 +88222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *446 - - *447 - - &818 + - *463 + - *464 + - &836 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86577,7 +88238,7 @@ paths: application/json: schema: type: array - items: &632 + items: &649 title: Porter Author description: Porter Author type: object @@ -86631,7 +88292,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86656,8 +88317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *446 - - *447 + - *463 + - *464 - name: author_id in: path required: true @@ -86687,7 +88348,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *649 examples: default: value: @@ -86700,7 +88361,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86724,8 +88385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86766,7 +88427,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86794,8 +88455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -86822,11 +88483,11 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: - default: *633 + default: *650 '422': *15 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86849,8 +88510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86858,8 +88519,8 @@ paths: application/json: schema: *22 examples: - default: *634 - '301': *460 + default: *651 + '301': *477 '404': *6 x-github: githubCloudOnly: false @@ -86879,8 +88540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86888,12 +88549,12 @@ paths: application/json: schema: anyOf: - - *337 + - *355 - type: object properties: {} additionalProperties: false examples: - default: &636 + default: &653 value: limit: collaborators_only origin: repository @@ -86918,13 +88579,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *635 + schema: *652 examples: default: summary: Example request body @@ -86936,9 +88597,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: - default: *636 + default: *653 '409': description: Response x-github: @@ -86960,8 +88621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -86984,8 +88645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -86995,9 +88656,9 @@ paths: application/json: schema: type: array - items: *637 + items: *654 examples: - default: &811 + default: &829 value: - id: 1 repository: @@ -87128,9 +88789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *446 - - *447 - - *341 + - *463 + - *464 + - *359 requestBody: required: false content: @@ -87159,7 +88820,7 @@ paths: description: Response content: application/json: - schema: *637 + schema: *654 examples: default: value: @@ -87290,9 +88951,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *446 - - *447 - - *341 + - *463 + - *464 + - *359 responses: '204': description: Response @@ -87323,8 +88984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *446 - - *447 + - *463 + - *464 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -87372,7 +89033,7 @@ paths: required: false schema: type: string - - *345 + - *363 - name: sort description: What to sort results by. in: query @@ -87384,8 +89045,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -87395,9 +89056,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: &646 + default: &663 value: - id: 1 node_id: MDU6SXNzdWUx @@ -87545,7 +89206,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *460 + '301': *477 '422': *15 '404': *6 x-github: @@ -87574,8 +89235,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -87657,9 +89318,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: &643 + default: &660 value: id: 1 node_id: MDU6SXNzdWUx @@ -87813,9 +89474,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *167 + '503': *183 '404': *6 - '410': *457 + '410': *474 x-github: triggersNotification: true githubCloudOnly: false @@ -87843,9 +89504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *446 - - *447 - - *213 + - *463 + - *464 + - *230 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -87855,7 +89516,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -87865,9 +89526,9 @@ paths: application/json: schema: type: array - items: *638 + items: *655 examples: - default: &645 + default: &662 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87925,17 +89586,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: &639 + default: &656 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87989,9 +89650,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -88013,9 +89674,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 '422': *15 x-github: githubCloudOnly: false @@ -88033,9 +89694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -88055,9 +89716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -88083,9 +89744,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -88106,9 +89767,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -88140,16 +89801,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -88171,10 +89832,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -88194,8 +89855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -88205,7 +89866,7 @@ paths: application/json: schema: type: array - items: &642 + items: &659 title: Issue Event description: Issue Event type: object @@ -88248,8 +89909,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *640 - required: *641 + properties: *657 + required: *658 nullable: true label: title: Issue Event Label @@ -88293,7 +89954,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *282 + requested_team: *302 dismissed_review: title: Issue Event Dismissed Review type: object @@ -88358,7 +90019,7 @@ paths: required: - from - to - author_association: *190 + author_association: *207 lock_reason: type: string nullable: true @@ -88371,8 +90032,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -88556,8 +90217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *446 - - *447 + - *463 + - *464 - name: event_id in: path required: true @@ -88568,7 +90229,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *659 examples: default: value: @@ -88761,7 +90422,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *457 + '410': *474 '403': *29 x-github: githubCloudOnly: false @@ -88795,9 +90456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *446 - - *447 - - &644 + - *463 + - *464 + - &661 name: issue_number description: The number that identifies the issue. in: path @@ -88809,12 +90470,12 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '404': *6 - '410': *457 + '410': *474 '304': *37 x-github: githubCloudOnly: false @@ -88839,9 +90500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -88945,15 +90606,15 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 '422': *15 - '503': *167 + '503': *183 '403': *29 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88971,9 +90632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -88999,9 +90660,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89017,9 +90678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: content: application/json: @@ -89044,9 +90705,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89068,9 +90729,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: assignee in: path required: true @@ -89110,10 +90771,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *446 - - *447 - - *644 - - *196 + - *463 + - *464 + - *661 + - *213 - *17 - *19 responses: @@ -89123,13 +90784,13 @@ paths: application/json: schema: type: array - items: *638 + items: *655 examples: - default: *645 + default: *662 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89158,9 +90819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -89182,16 +90843,16 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -89219,9 +90880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89231,14 +90892,14 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89266,9 +90927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -89290,17 +90951,17 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *460 + '301': *477 '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -89331,9 +90992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -89345,15 +91006,15 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 x-github: triggersNotification: true githubCloudOnly: false @@ -89379,9 +91040,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89391,14 +91052,14 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89415,9 +91076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89431,7 +91092,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &648 + - &665 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -89462,8 +91123,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 label: type: object properties: @@ -89485,7 +91146,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &649 + - &666 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -89516,8 +91177,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 label: type: object properties: @@ -89605,8 +91266,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 assigner: *4 required: @@ -89621,7 +91282,7 @@ paths: - performed_via_github_app - assignee - assigner - - &650 + - &667 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -89652,8 +91313,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 milestone: type: object properties: @@ -89672,7 +91333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &651 + - &668 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -89703,8 +91364,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 milestone: type: object properties: @@ -89723,7 +91384,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &652 + - &669 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -89754,8 +91415,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 rename: type: object properties: @@ -89777,7 +91438,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &653 + - &670 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -89808,10 +91469,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 review_requester: *4 - requested_team: *282 + requested_team: *302 requested_reviewer: *4 required: - review_requester @@ -89824,7 +91485,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &654 + - &671 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -89855,10 +91516,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 review_requester: *4 - requested_team: *282 + requested_team: *302 requested_reviewer: *4 required: - review_requester @@ -89871,7 +91532,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &655 + - &672 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -89902,8 +91563,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 dismissed_review: type: object properties: @@ -89931,7 +91592,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &656 + - &673 title: Locked Issue Event description: Locked Issue Event type: object @@ -89962,8 +91623,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 lock_reason: type: string example: '"off-topic"' @@ -89979,7 +91640,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &657 + - &674 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -90010,8 +91671,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90045,7 +91706,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &658 + - &675 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -90076,8 +91737,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90111,7 +91772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &659 + - &676 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -90142,8 +91803,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90177,7 +91838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &677 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -90268,7 +91929,7 @@ paths: color: red headers: Link: *43 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90285,9 +91946,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -90297,9 +91958,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: &647 + default: &664 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -90317,9 +91978,9 @@ paths: default: false headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90336,9 +91997,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90397,12 +92058,12 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 - '301': *460 + default: *664 + '301': *477 '404': *6 - '410': *457 + '410': *474 '422': *15 x-github: githubCloudOnly: false @@ -90419,9 +92080,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90481,12 +92142,12 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 - '301': *460 + default: *664 + '301': *477 '404': *6 - '410': *457 + '410': *474 '422': *15 x-github: githubCloudOnly: false @@ -90503,15 +92164,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '204': description: Response - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90530,9 +92191,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: name in: path required: true @@ -90545,7 +92206,7 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: default: value: @@ -90556,9 +92217,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90578,9 +92239,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90608,7 +92269,7 @@ paths: '204': description: Response '403': *29 - '410': *457 + '410': *474 '404': *6 '422': *15 x-github: @@ -90626,9 +92287,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '204': description: Response @@ -90658,20 +92319,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '200': description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90688,9 +92349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -90716,13 +92377,13 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90740,9 +92401,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90774,16 +92435,16 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -90805,10 +92466,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *446 - - *447 - - *644 - - *438 + - *463 + - *464 + - *661 + - *455 responses: '204': description: Response @@ -90837,9 +92498,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90861,9 +92522,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -90896,9 +92557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -90908,13 +92569,13 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90942,9 +92603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90971,16 +92632,16 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -91000,9 +92661,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -91033,13 +92694,13 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 '403': *29 '404': *6 '422': *7 - '503': *167 + '503': *183 x-github: triggersNotification: true githubCloudOnly: false @@ -91057,9 +92718,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -91074,19 +92735,19 @@ paths: description: Timeline Event type: object anyOf: - - *648 - - *649 - - *650 - - *651 - - *652 - - *653 - - *654 - - *655 - - *656 - - *657 - - *658 - - *659 - - *660 + - *665 + - *666 + - *667 + - *668 + - *669 + - *670 + - *671 + - *672 + - *673 + - *674 + - *675 + - *676 + - *677 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -91129,7 +92790,7 @@ paths: issue_url: type: string format: uri - author_association: *190 + author_association: *207 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -91139,9 +92800,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - event - actor @@ -91172,7 +92833,7 @@ paths: properties: type: type: string - issue: *189 + issue: *206 required: - event - created_at @@ -91372,7 +93033,7 @@ paths: type: string body_text: type: string - author_association: *190 + author_association: *207 required: - event - id @@ -91395,7 +93056,7 @@ paths: type: string comments: type: array - items: &680 + items: &699 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -91484,7 +93145,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *190 + author_association: *207 _links: type: object properties: @@ -91568,7 +93229,7 @@ paths: enum: - line - file - reactions: *191 + reactions: *208 body_html: type: string example: '"

comment body

"' @@ -91604,7 +93265,7 @@ paths: type: string comments: type: array - items: *563 + items: *580 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -91635,8 +93296,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 required: - id @@ -91679,8 +93340,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 required: - id @@ -91723,8 +93384,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 state_reason: type: string nullable: true @@ -91893,7 +93554,7 @@ paths: headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91910,8 +93571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -91921,7 +93582,7 @@ paths: application/json: schema: type: array - items: &661 + items: &678 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -91987,8 +93648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92024,9 +93685,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *678 examples: - default: &662 + default: &679 value: id: 1 key: ssh-rsa AAA... @@ -92060,9 +93721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *446 - - *447 - - &663 + - *463 + - *464 + - &680 name: key_id description: The unique identifier of the key. in: path @@ -92074,9 +93735,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *678 examples: - default: *662 + default: *679 '404': *6 x-github: githubCloudOnly: false @@ -92094,9 +93755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *446 - - *447 - - *663 + - *463 + - *464 + - *680 responses: '204': description: Response @@ -92116,8 +93777,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -92127,9 +93788,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 + default: *664 headers: Link: *43 '404': *6 @@ -92150,8 +93811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92187,9 +93848,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: - default: &664 + default: &681 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92221,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92233,9 +93894,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: - default: *664 + default: *681 '404': *6 x-github: githubCloudOnly: false @@ -92252,8 +93913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92292,7 +93953,7 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: default: value: @@ -92318,8 +93979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92345,8 +94006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -92382,8 +94043,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '202': *39 '403': @@ -92411,8 +94072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -92438,9 +94099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *446 - - *447 - - *539 + - *463 + - *464 + - *556 responses: '200': description: Response @@ -92502,8 +94163,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true required: - _links @@ -92585,8 +94246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92651,8 +94312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92686,9 +94347,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *564 + schema: *581 examples: - default: *665 + default: *682 '204': description: Response when already merged '404': @@ -92713,8 +94374,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -92755,12 +94416,12 @@ paths: application/json: schema: type: array - items: &666 + items: &683 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 examples: default: value: @@ -92816,8 +94477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92857,9 +94518,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: &667 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -92918,9 +94579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *446 - - *447 - - &668 + - *463 + - *464 + - &685 name: milestone_number description: The number that identifies the milestone. in: path @@ -92932,9 +94593,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: *667 + default: *684 '404': *6 x-github: githubCloudOnly: false @@ -92951,9 +94612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 requestBody: required: false content: @@ -92991,9 +94652,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: *667 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93009,9 +94670,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 responses: '204': description: Response @@ -93032,9 +94693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 - *17 - *19 responses: @@ -93044,9 +94705,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 + default: *664 headers: Link: *43 x-github: @@ -93065,12 +94726,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *446 - - *447 - - *669 - - *670 - - *196 - - *671 + - *463 + - *464 + - *686 + - *687 + - *213 + - *688 - *17 - *19 responses: @@ -93080,9 +94741,9 @@ paths: application/json: schema: type: array - items: *216 + items: *233 examples: - default: *672 + default: *689 headers: Link: *43 x-github: @@ -93106,8 +94767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -93165,14 +94826,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &673 + schema: &690 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -93297,7 +94958,7 @@ paths: - custom_404 - public examples: - default: &674 + default: &691 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -93338,8 +94999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93393,11 +95054,11 @@ paths: description: Response content: application/json: - schema: *673 + schema: *690 examples: - default: *674 + default: *691 '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93418,8 +95079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93505,7 +95166,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93526,14 +95187,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93553,8 +95214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -93564,7 +95225,7 @@ paths: application/json: schema: type: array - items: &675 + items: &692 title: Page Build description: Page Build type: object @@ -93658,8 +95319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response @@ -93704,16 +95365,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *675 + schema: *692 examples: - default: &676 + default: &693 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -93761,8 +95422,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *446 - - *447 + - *463 + - *464 - name: build_id in: path required: true @@ -93773,9 +95434,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *692 examples: - default: *676 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93795,8 +95456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93901,9 +95562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *446 - - *447 - - &677 + - *463 + - *464 + - &694 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -93961,11 +95622,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *446 - - *447 - - *677 + - *463 + - *464 + - *694 responses: - '204': *133 + '204': *143 '404': *6 x-github: githubCloudOnly: false @@ -93990,8 +95651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -94222,7 +95883,7 @@ paths: description: Empty response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -94249,8 +95910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Private vulnerability reporting status @@ -94287,10 +95948,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 + '204': *143 '422': *14 x-github: githubCloudOnly: false @@ -94309,10 +95970,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 + '204': *143 '422': *14 x-github: githubCloudOnly: false @@ -94333,8 +95994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: Indicates the state of the projects to return. in: query @@ -94355,7 +96016,7 @@ paths: application/json: schema: type: array - items: *374 + items: *392 examples: default: value: @@ -94395,7 +96056,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -94418,8 +96079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94445,13 +96106,13 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: *456 + default: *473 '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -94474,8 +96135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -94483,16 +96144,9 @@ paths: application/json: schema: type: array - items: *389 + items: *144 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *695 '403': *29 '404': *6 x-github: @@ -94514,8 +96168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94527,19 +96181,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *389 + items: *144 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *696 responses: '204': description: No Content when custom property values are successfully created @@ -94577,8 +96223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -94638,9 +96284,9 @@ paths: application/json: schema: type: array - items: *568 + items: *585 examples: - default: *678 + default: *697 headers: Link: *43 '304': *37 @@ -94672,8 +96318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94738,7 +96384,7 @@ paths: description: Response content: application/json: - schema: &682 + schema: &701 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -94849,8 +96495,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true active_lock_reason: type: string @@ -94895,7 +96541,7 @@ paths: nullable: true requested_teams: type: array - items: *413 + items: *430 nullable: true head: type: object @@ -94904,7 +96550,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: *4 @@ -94921,7 +96567,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: *4 @@ -94934,14 +96580,14 @@ paths: _links: type: object properties: - comments: *382 - commits: *382 - statuses: *382 - html: *382 - issue: *382 - review_comments: *382 - review_comment: *382 - self: *382 + comments: *400 + commits: *400 + statuses: *400 + html: *400 + issue: *400 + review_comments: *400 + review_comment: *400 + self: *400 required: - comments - commits @@ -94951,8 +96597,8 @@ paths: - review_comments - review_comment - self - author_association: *190 - auto_merge: *679 + author_association: *207 + auto_merge: *698 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -95044,7 +96690,7 @@ paths: - merged_by - review_comments examples: - default: &683 + default: &702 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -95571,8 +97217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: sort in: query required: false @@ -95591,7 +97237,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -95601,9 +97247,9 @@ paths: application/json: schema: type: array - items: *680 + items: *699 examples: - default: &685 + default: &704 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95680,17 +97326,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *680 + schema: *699 examples: - default: &681 + default: &700 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95765,9 +97411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -95789,9 +97435,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: - default: *681 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95807,9 +97453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -95830,9 +97476,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -95858,9 +97504,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -95881,9 +97527,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -95915,16 +97561,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -95946,10 +97592,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -95992,9 +97638,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *446 - - *447 - - &684 + - *463 + - *464 + - &703 name: pull_number description: The number that identifies the pull request. in: path @@ -96007,9 +97653,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *682 + schema: *701 examples: - default: *683 + default: *702 '304': *37 '404': *6 '406': @@ -96018,7 +97664,7 @@ paths: application/json: schema: *3 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96044,9 +97690,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96088,9 +97734,9 @@ paths: description: Response content: application/json: - schema: *682 + schema: *701 examples: - default: *683 + default: *702 '422': *15 '403': *29 x-github: @@ -96112,9 +97758,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -96174,21 +97820,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96214,10 +97860,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *446 - - *447 - - *684 - - *213 + - *463 + - *464 + - *703 + - *230 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -96227,7 +97873,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -96237,9 +97883,9 @@ paths: application/json: schema: type: array - items: *680 + items: *699 examples: - default: *685 + default: *704 headers: Link: *43 x-github: @@ -96272,9 +97918,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -96379,7 +98025,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: example-for-a-multi-line-comment: value: @@ -96467,10 +98113,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *446 - - *447 - - *684 - - *205 + - *463 + - *464 + - *703 + - *222 requestBody: required: true content: @@ -96492,7 +98138,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: default: value: @@ -96578,9 +98224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -96590,9 +98236,9 @@ paths: application/json: schema: type: array - items: *564 + items: *581 examples: - default: *686 + default: *705 headers: Link: *43 x-github: @@ -96622,9 +98268,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -96634,7 +98280,7 @@ paths: application/json: schema: type: array - items: *577 + items: *594 examples: default: value: @@ -96653,7 +98299,7 @@ paths: Link: *43 '422': *15 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96672,9 +98318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 responses: '204': description: Response if pull request has been merged @@ -96697,9 +98343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96810,9 +98456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 responses: '200': description: Response @@ -96828,7 +98474,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 required: - users - teams @@ -96887,9 +98533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96926,7 +98572,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *585 examples: default: value: @@ -97462,9 +99108,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -97498,7 +99144,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *585 examples: default: value: @@ -98003,9 +99649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -98015,7 +99661,7 @@ paths: application/json: schema: type: array - items: &687 + items: &706 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -98084,7 +99730,7 @@ paths: type: string body_text: type: string - author_association: *190 + author_association: *207 required: - id - node_id @@ -98166,9 +99812,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -98254,9 +99900,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: &689 + default: &708 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98319,10 +99965,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - &688 + - *463 + - *464 + - *703 + - &707 name: review_id description: The unique identifier of the review. in: path @@ -98334,9 +99980,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: &690 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98395,10 +100041,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98421,7 +100067,7 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: default: value: @@ -98483,18 +100129,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 responses: '200': description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: *689 + default: *708 '422': *7 '404': *6 x-github: @@ -98521,10 +100167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 - *17 - *19 responses: @@ -98603,13 +100249,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *190 + author_association: *207 _links: type: object properties: - self: *382 - html: *382 - pull_request: *382 + self: *400 + html: *400 + pull_request: *400 required: - self - html @@ -98618,7 +100264,7 @@ paths: type: string body_html: type: string - reactions: *191 + reactions: *208 side: description: The side of the first line of the range for a multi-line comment. @@ -98759,10 +100405,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98790,7 +100436,7 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: default: value: @@ -98853,10 +100499,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98891,9 +100537,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: *690 + default: *709 '404': *6 '422': *7 '403': *29 @@ -98915,9 +100561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -98980,8 +100626,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -98994,9 +100640,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *710 examples: - default: &692 + default: &711 value: type: file encoding: base64 @@ -99038,8 +100684,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *446 - - *447 + - *463 + - *464 - name: dir description: The alternate path to look for a README file in: path @@ -99059,9 +100705,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *710 examples: - default: *692 + default: *711 '404': *6 '422': *15 x-github: @@ -99083,8 +100729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -99094,7 +100740,7 @@ paths: application/json: schema: type: array - items: *693 + items: *712 examples: default: value: @@ -99188,8 +100834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -99265,9 +100911,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: &697 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -99372,9 +101018,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *446 - - *447 - - &695 + - *463 + - *464 + - &714 name: asset_id description: The unique identifier of the asset. in: path @@ -99386,9 +101032,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: - default: &696 + default: &715 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -99423,7 +101069,7 @@ paths: type: User site_admin: false '404': *6 - '302': *579 + '302': *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99439,9 +101085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *446 - - *447 - - *695 + - *463 + - *464 + - *714 requestBody: required: false content: @@ -99469,9 +101115,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: - default: *696 + default: *715 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99487,9 +101133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *446 - - *447 - - *695 + - *463 + - *464 + - *714 responses: '204': description: Response @@ -99513,8 +101159,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -99599,16 +101245,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99625,8 +101271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *446 - - *447 + - *463 + - *464 - name: tag description: tag parameter in: path @@ -99639,9 +101285,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '404': *6 x-github: githubCloudOnly: false @@ -99663,9 +101309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *446 - - *447 - - &698 + - *463 + - *464 + - &717 name: release_id description: The unique identifier of the release. in: path @@ -99679,9 +101325,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '401': description: Unauthorized x-github: @@ -99699,9 +101345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 requestBody: required: false content: @@ -99765,9 +101411,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '404': description: Not Found if the discussion category name is invalid content: @@ -99788,9 +101434,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 responses: '204': description: Response @@ -99810,9 +101456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - *17 - *19 responses: @@ -99822,7 +101468,7 @@ paths: application/json: schema: type: array - items: *694 + items: *713 examples: default: value: @@ -99904,9 +101550,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - name: name in: query required: true @@ -99932,7 +101578,7 @@ paths: description: Response for successful upload content: application/json: - schema: *694 + schema: *713 examples: response-for-successful-upload: value: @@ -99987,9 +101633,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -100013,9 +101659,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -100036,9 +101682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 requestBody: required: true content: @@ -100068,16 +101714,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -100099,10 +101745,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *446 - - *447 - - *698 - - *438 + - *463 + - *464 + - *717 + - *455 responses: '204': description: Response @@ -100126,9 +101772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 - *17 - *19 responses: @@ -100144,8 +101790,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *142 - - &699 + - *158 + - &718 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -100165,68 +101811,68 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: - - *143 - - *699 + - *159 + - *718 - allOf: - - *144 - - *699 + - *160 + - *718 - allOf: - - *145 - - *699 + - *161 + - *718 - allOf: - - *700 - - *699 + - *719 + - *718 - allOf: - - *146 - - *699 + - *162 + - *718 - allOf: - - *147 - - *699 + - *163 + - *718 - allOf: - - *148 - - *699 + - *164 + - *718 - allOf: - - *149 - - *699 + - *165 + - *718 - allOf: - - *150 - - *699 + - *166 + - *718 - allOf: - - *151 - - *699 + - *167 + - *718 - allOf: - - *152 - - *699 + - *168 + - *718 - allOf: - - *153 - - *699 + - *169 + - *718 - allOf: - - *154 - - *699 + - *170 + - *718 - allOf: - - *155 - - *699 + - *171 + - *718 - allOf: - - *156 - - *699 + - *172 + - *718 - allOf: - - *157 - - *699 + - *173 + - *718 - allOf: - - *158 - - *699 + - *174 + - *718 - allOf: - - *159 - - *699 + - *175 + - *718 - allOf: - - *160 - - *699 + - *176 + - *718 - allOf: - - *161 - - *699 + - *177 + - *718 - allOf: - - *701 - - *699 + - *720 + - *718 examples: default: value: @@ -100265,8 +101911,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - name: includes_parents @@ -100277,7 +101923,7 @@ paths: schema: type: boolean default: true - - *702 + - *721 responses: '200': description: Response @@ -100285,7 +101931,7 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: default: value: @@ -100332,8 +101978,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 requestBody: description: Request body required: true @@ -100353,16 +101999,16 @@ paths: - tag - push default: branch - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *136 + items: *157 + conditions: *150 rules: type: array description: An array of rules within the ruleset. - items: *703 + items: *722 required: - name - enforcement @@ -100393,9 +102039,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: &712 + default: &731 value: id: 42 name: super cool ruleset @@ -100442,12 +102088,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *446 - - *447 - - *704 - - *96 - - *705 - - *706 + - *463 + - *464 + - *723 + - *101 + - *724 + - *725 - *17 - *19 responses: @@ -100455,9 +102101,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *726 examples: - default: *708 + default: *727 '404': *6 '500': *40 x-github: @@ -100478,17 +102124,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *446 - - *447 - - *709 + - *463 + - *464 + - *728 responses: '200': description: Response content: application/json: - schema: *710 + schema: *729 examples: - default: *711 + default: *730 '404': *6 '500': *40 x-github: @@ -100516,8 +102162,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100537,9 +102183,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *712 + default: *731 '404': *6 '500': *40 put: @@ -100557,8 +102203,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100583,16 +102229,16 @@ paths: - branch - tag - push - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *136 + items: *157 + conditions: *150 rules: description: An array of rules within the ruleset. type: array - items: *703 + items: *722 examples: default: value: @@ -100620,9 +102266,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *712 + default: *731 '404': *6 '500': *40 delete: @@ -100640,8 +102286,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100664,8 +102310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - name: ruleset_id @@ -100681,9 +102327,9 @@ paths: application/json: schema: type: array - items: *166 + items: *182 examples: - default: *398 + default: *415 '404': *6 '500': *40 x-github: @@ -100702,8 +102348,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100721,7 +102367,7 @@ paths: description: Response content: application/json: - schema: *399 + schema: *416 examples: default: value: @@ -100776,21 +102422,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *446 - - *447 - - *400 - - *401 - - *402 - - *403 - - *101 + - *463 + - *464 + - *417 + - *418 + - *419 + - *420 + - *106 - *19 - *17 - - *713 - - *714 - - *404 - - *405 - - *406 - - *407 + - *732 + - *733 + - *421 + - *422 + - *423 + - *424 responses: '200': description: Response @@ -100798,11 +102444,11 @@ paths: application/json: schema: type: array - items: &718 + items: &737 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -100810,15 +102456,15 @@ paths: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *715 - resolution: *716 + state: *734 + resolution: *735 resolved_at: type: string format: date-time @@ -100914,7 +102560,7 @@ paths: pull request. ' - oneOf: *717 + oneOf: *736 nullable: true has_more_locations: type: boolean @@ -101041,7 +102687,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101063,16 +102709,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 - - *407 + - *463 + - *464 + - *550 + - *424 responses: '200': description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -101103,7 +102749,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101124,9 +102770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: true content: @@ -101134,8 +102780,8 @@ paths: schema: type: object properties: - state: *715 - resolution: *716 + state: *734 + resolution: *735 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -101153,7 +102799,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -101206,7 +102852,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -101228,9 +102874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 - *19 - *17 responses: @@ -101241,7 +102887,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &899 + items: &917 type: object properties: type: @@ -101267,19 +102913,19 @@ paths: example: commit details: oneOf: - - *719 - - *720 - - *721 - - *722 - - *723 - - *724 - - *725 - - *726 - - *727 - - *728 - - *729 - - *730 - - *731 + - *738 + - *739 + - *740 + - *741 + - *742 + - *743 + - *744 + - *745 + - *746 + - *747 + - *748 + - *749 + - *750 examples: default: value: @@ -101343,7 +102989,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101365,8 +103011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -101374,14 +103020,14 @@ paths: schema: type: object properties: - reason: &733 + reason: &752 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *732 + placeholder_id: *751 required: - reason - placeholder_id @@ -101398,7 +103044,7 @@ paths: schema: type: object properties: - reason: *733 + reason: *752 expire_at: type: string format: date-time @@ -101421,7 +103067,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -101433,6 +103079,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -101441,13 +103090,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *167 + '503': *183 '200': description: Response content: @@ -101457,7 +103106,7 @@ paths: properties: incremental_scans: type: array - items: &734 + items: &753 description: Information on a single scan performed by secret scanning on the repository type: object @@ -101483,15 +103132,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *734 + items: *753 backfill_scans: type: array - items: *734 + items: *753 custom_pattern_backfill_scans: type: array items: allOf: - - *734 + - *753 - type: object properties: pattern_name: @@ -101561,9 +103210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *446 - - *447 - - *101 + - *463 + - *464 + - *106 - name: sort description: The property to sort the results by. in: query @@ -101575,8 +103224,8 @@ paths: - updated - published default: created - - *99 - - *100 + - *104 + - *105 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -101606,9 +103255,9 @@ paths: application/json: schema: type: array - items: *735 + items: *754 examples: - default: *736 + default: *755 '400': *14 '404': *6 x-github: @@ -101631,8 +103280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -101705,7 +103354,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 required: - login - type @@ -101792,9 +103441,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: &738 + default: &757 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -102027,8 +103676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -102132,7 +103781,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: default: value: @@ -102279,17 +103928,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '200': description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: *738 + default: *757 '403': *29 '404': *6 x-github: @@ -102313,9 +103962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 requestBody: required: true content: @@ -102388,7 +104037,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 required: - login - type @@ -102474,17 +104123,17 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: *738 - add_credit: *738 + default: *757 + add_credit: *757 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *232 + schema: *250 examples: invalid_state_transition: value: @@ -102515,9 +104164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '202': *39 '400': *14 @@ -102544,17 +104193,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '202': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 '400': *14 '422': *15 '403': *29 @@ -102580,8 +104229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -102680,8 +104329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -102690,7 +104339,7 @@ paths: application/json: schema: type: array - items: &739 + items: &758 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -102703,7 +104352,7 @@ paths: - 1124 - -435 '202': *39 - '204': *133 + '204': *143 '422': description: Repository contains more than 10,000 commits x-github: @@ -102723,8 +104372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -102773,7 +104422,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102800,8 +104449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -102875,7 +104524,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102897,8 +104546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -103052,8 +104701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -103063,7 +104712,7 @@ paths: application/json: schema: type: array - items: *739 + items: *758 examples: default: value: @@ -103076,7 +104725,7 @@ paths: - - 0 - 2 - 21 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103096,8 +104745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *446 - - *447 + - *463 + - *464 - name: sha in: path required: true @@ -103151,7 +104800,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *759 examples: default: value: @@ -103205,8 +104854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103218,7 +104867,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -103238,14 +104887,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &741 + schema: &760 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -103313,8 +104962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -103340,7 +104989,7 @@ paths: description: Response content: application/json: - schema: *741 + schema: *760 examples: default: value: @@ -103367,8 +105016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -103388,8 +105037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103468,8 +105117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -103477,7 +105126,7 @@ paths: application/json: schema: type: array - items: &742 + items: &761 title: Tag protection description: Tag protection type: object @@ -103529,8 +105178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -103553,7 +105202,7 @@ paths: description: Response content: application/json: - schema: *742 + schema: *761 examples: default: value: @@ -103584,8 +105233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -103622,8 +105271,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *446 - - *447 + - *463 + - *464 - name: ref in: path required: true @@ -103659,8 +105308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103670,9 +105319,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 headers: Link: *43 '404': *6 @@ -103692,8 +105341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 responses: @@ -103701,7 +105350,7 @@ paths: description: Response content: application/json: - schema: &743 + schema: &762 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -103713,7 +105362,7 @@ paths: required: - names examples: - default: &744 + default: &763 value: names: - octocat @@ -103736,8 +105385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -103768,9 +105417,9 @@ paths: description: Response content: application/json: - schema: *743 + schema: *762 examples: - default: *744 + default: *763 '404': *6 '422': *7 x-github: @@ -103791,9 +105440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *446 - - *447 - - &745 + - *463 + - *464 + - &764 name: per description: The time frame to display results for. in: query @@ -103822,7 +105471,7 @@ paths: example: 128 clones: type: array - items: &746 + items: &765 title: Traffic type: object properties: @@ -103909,8 +105558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -104000,8 +105649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -104061,9 +105710,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *446 - - *447 - - *745 + - *463 + - *464 + - *764 responses: '200': description: Response @@ -104082,7 +105731,7 @@ paths: example: 3782 views: type: array - items: *746 + items: *765 required: - uniques - count @@ -104159,8 +105808,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -104196,7 +105845,7 @@ paths: description: Response content: application/json: - schema: *255 + schema: *275 examples: default: value: @@ -104434,8 +106083,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -104458,8 +106107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -104481,8 +106130,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -104508,8 +106157,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *446 - - *447 + - *463 + - *464 - name: ref in: path required: true @@ -104601,9 +106250,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -104644,7 +106293,7 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: default: value: @@ -104754,7 +106403,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &754 + - &773 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -104763,7 +106412,7 @@ paths: schema: type: string example: members - - &759 + - &778 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -104774,7 +106423,7 @@ paths: default: 1 format: int32 example: 1 - - &760 + - &779 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -104816,7 +106465,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &749 + items: &768 allOf: - type: object required: @@ -104891,7 +106540,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &761 + meta: &780 type: object description: The metadata associated with the creation/updates to the user. @@ -104951,30 +106600,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &750 + '400': &769 description: Bad request content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '401': *748 - '403': &751 + schema: *766 + '401': *767 + '403': &770 description: Permission denied - '429': &752 + '429': &771 description: Too many requests content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '500': &753 + schema: *766 + '500': &772 description: Internal server error content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 + schema: *766 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -104998,7 +106647,7 @@ paths: required: true content: application/json: - schema: &757 + schema: &776 type: object required: - schemas @@ -105058,9 +106707,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *749 + schema: *768 examples: - group: &755 + group: &774 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -105079,13 +106728,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *750 - '401': *748 - '403': *751 - '409': &758 + '400': *769 + '401': *767 + '403': *770 + '409': &777 description: Duplicate record detected - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105102,7 +106751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &756 + - &775 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -105110,22 +106759,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *754 + - *773 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *749 + schema: *768 examples: - default: *755 - '400': *750 - '401': *748 - '403': *751 + default: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105144,13 +106793,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *756 + - *775 - *41 requestBody: required: true content: application/json: - schema: *757 + schema: *776 examples: group: summary: Group @@ -105176,17 +106825,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *749 + schema: *768 examples: - group: *755 - groupWithMembers: *755 - '400': *750 - '401': *748 - '403': *751 + group: *774 + groupWithMembers: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105210,13 +106859,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *756 + - *775 - *41 requestBody: required: true content: application/json: - schema: &768 + schema: &787 type: object required: - Operations @@ -105276,17 +106925,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *749 + schema: *768 examples: - updateGroup: *755 - addMembers: *755 - '400': *750 - '401': *748 - '403': *751 + updateGroup: *774 + addMembers: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105302,17 +106951,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *756 + - *775 - *41 responses: '204': description: Group was deleted, no content - '400': *750 - '401': *748 - '403': *751 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105346,8 +106995,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *759 - - *760 + - *778 + - *779 - *41 responses: '200': @@ -105380,7 +107029,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &763 + items: &782 allOf: - type: object required: @@ -105459,7 +107108,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &762 + roles: &781 type: array description: The roles assigned to the user. items: @@ -105515,7 +107164,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *761 + meta: *780 startIndex: type: integer description: A starting index for the returned page @@ -105552,11 +107201,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *750 - '401': *748 - '403': *751 - '429': *752 - '500': *753 + '400': *769 + '401': *767 + '403': *770 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105580,7 +107229,7 @@ paths: required: true content: application/json: - schema: &766 + schema: &785 type: object required: - schemas @@ -105662,9 +107311,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *762 + roles: *781 examples: - user: &767 + user: &786 summary: User value: schemas: @@ -105711,9 +107360,9 @@ paths: description: User has been created content: application/scim+json: - schema: *763 + schema: *782 examples: - user: &764 + user: &783 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -105739,13 +107388,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *764 - '400': *750 - '401': *748 - '403': *751 - '409': *758 - '429': *752 - '500': *753 + enterpriseOwner: *783 + '400': *769 + '401': *767 + '403': *770 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105762,7 +107411,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &765 + - &784 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -105775,15 +107424,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *763 + schema: *782 examples: - default: *764 - '400': *750 - '401': *748 - '403': *751 + default: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105805,30 +107454,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *765 + - *784 - *41 requestBody: required: true content: application/json: - schema: *766 + schema: *785 examples: - user: *767 + user: *786 responses: '200': description: User was updated content: application/scim+json: - schema: *763 + schema: *782 examples: - user: *764 - '400': *750 - '401': *748 - '403': *751 + user: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105863,13 +107512,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *765 + - *784 - *41 requestBody: required: true content: application/json: - schema: *768 + schema: *787 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -105909,18 +107558,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *763 + schema: *782 examples: - userMultiValuedProperties: *764 - userSingleValuedProperties: *764 - disableUser: *764 - '400': *750 - '401': *748 - '403': *751 + userMultiValuedProperties: *783 + userSingleValuedProperties: *783 + disableUser: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105940,17 +107589,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *765 + - *784 - *41 responses: '204': description: User was deleted, no content - '400': *750 - '401': *748 - '403': *751 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105983,7 +107632,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *78 + - *83 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -106037,7 +107686,7 @@ paths: example: 1 Resources: type: array - items: &769 + items: &788 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -106268,22 +107917,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &770 + '404': &789 description: Resource not found content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '403': &771 + schema: *766 + '403': &790 description: Forbidden content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '400': *750 - '429': *752 + schema: *766 + '400': *769 + '429': *771 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -106303,15 +107952,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *78 + - *83 responses: '201': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: &772 + default: &791 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -106334,17 +107983,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *770 - '403': *771 - '500': *753 + '404': *789 + '403': *790 + '500': *772 '409': description: Conflict content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '400': *750 + schema: *766 + '400': *769 requestBody: required: true content: @@ -106441,18 +108090,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 - '404': *770 - '403': *771 + default: *791 + '404': *789 + '403': *790 '304': *37 x-github: githubCloudOnly: true @@ -106475,19 +108124,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 + default: *791 '304': *37 - '404': *770 - '403': *771 + '404': *789 + '403': *790 requestBody: required: true content: @@ -106599,20 +108248,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 + default: *791 '304': *37 - '404': *770 - '403': *771 - '400': *750 + '404': *789 + '403': *790 + '400': *769 '429': description: Response content: @@ -106702,13 +108351,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *78 - - *765 + - *83 + - *784 responses: '204': description: Response - '404': *770 - '403': *771 + '404': *789 + '403': *790 '304': *37 x-github: githubCloudOnly: true @@ -106823,7 +108472,7 @@ paths: html_url: type: string format: uri - repository: *255 + repository: *275 score: type: number file_size: @@ -106841,7 +108490,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &773 + text_matches: &792 title: Search Result Text Matches type: array items: @@ -106955,7 +108604,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *167 + '503': *183 '422': *15 '403': *29 x-github: @@ -107004,7 +108653,7 @@ paths: enum: - author-date - committer-date - - &774 + - &793 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -107075,7 +108724,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true comment_count: type: integer @@ -107095,7 +108744,7 @@ paths: url: type: string format: uri - verification: *624 + verification: *641 required: - author - committer @@ -107114,7 +108763,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true parents: type: array @@ -107127,12 +108776,12 @@ paths: type: string sha: type: string - repository: *255 + repository: *275 score: type: number node_id: type: string - text_matches: *773 + text_matches: *792 required: - sha - node_id @@ -107325,7 +108974,7 @@ paths: - interactions - created - updated - - *774 + - *793 - *17 - *19 - name: advanced_search @@ -107422,11 +109071,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: type: string state_reason: @@ -107443,8 +109092,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true comments: type: integer @@ -107458,7 +109107,7 @@ paths: type: string format: date-time nullable: true - text_matches: *773 + text_matches: *792 pull_request: type: object properties: @@ -107491,10 +109140,10 @@ paths: type: string score: type: number - author_association: *190 + author_association: *207 draft: type: boolean - repository: *69 + repository: *74 body_html: type: string body_text: @@ -107502,7 +109151,7 @@ paths: timeline_url: type: string format: uri - type: *342 + type: *360 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -107512,9 +109161,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - assignee - closed_at @@ -107630,7 +109279,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *167 + '503': *183 '422': *15 '304': *37 '403': *29 @@ -107683,7 +109332,7 @@ paths: enum: - created - updated - - *774 + - *793 - *17 - *19 responses: @@ -107727,7 +109376,7 @@ paths: nullable: true score: type: number - text_matches: *773 + text_matches: *792 required: - id - node_id @@ -107813,7 +109462,7 @@ paths: - forks - help-wanted-issues - updated - - *774 + - *793 - *17 - *19 responses: @@ -108032,8 +109681,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true permissions: type: object @@ -108052,7 +109701,7 @@ paths: - admin - pull - push - text_matches: *773 + text_matches: *792 temp_clone_token: type: string allow_merge_commit: @@ -108254,7 +109903,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *167 + '503': *183 '422': *15 '304': *37 x-github: @@ -108353,7 +110002,7 @@ paths: type: string format: uri nullable: true - text_matches: *773 + text_matches: *792 related: type: array nullable: true @@ -108546,7 +110195,7 @@ paths: - followers - repositories - joined - - *774 + - *793 - *17 - *19 responses: @@ -108650,7 +110299,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *773 + text_matches: *792 blog: type: string nullable: true @@ -108709,7 +110358,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *167 + '503': *183 '422': *15 x-github: githubCloudOnly: false @@ -108729,7 +110378,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &778 + - &797 name: team_id description: The unique identifier of the team. in: path @@ -108741,9 +110390,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 x-github: githubCloudOnly: false @@ -108770,7 +110419,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -108833,16 +110482,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '201': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 '422': *15 '403': *29 @@ -108870,7 +110519,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *778 + - *797 responses: '204': description: Response @@ -108901,8 +110550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *778 - - *101 + - *797 + - *106 - *17 - *19 responses: @@ -108912,9 +110561,9 @@ paths: application/json: schema: type: array - items: *429 + items: *446 examples: - default: *779 + default: *798 headers: Link: *43 x-github: @@ -108943,7 +110592,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -108977,9 +110626,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: triggersNotification: true githubCloudOnly: false @@ -109006,16 +110655,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 responses: '200': description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109040,8 +110689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: false content: @@ -109064,9 +110713,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *780 + default: *799 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109091,8 +110740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 responses: '204': description: Response @@ -109121,9 +110770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *778 - - *431 - - *101 + - *797 + - *448 + - *106 - *17 - *19 responses: @@ -109133,9 +110782,9 @@ paths: application/json: schema: type: array - items: *432 + items: *449 examples: - default: *781 + default: *800 headers: Link: *43 x-github: @@ -109164,8 +110813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: true content: @@ -109187,9 +110836,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: triggersNotification: true githubCloudOnly: false @@ -109216,17 +110865,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109251,9 +110900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 requestBody: required: true content: @@ -109275,9 +110924,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *782 + default: *801 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109302,9 +110951,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 responses: '204': description: Response @@ -109333,9 +110982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -109361,9 +111010,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -109392,9 +111041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 requestBody: required: true content: @@ -109426,9 +111075,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109454,8 +111103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -109481,9 +111130,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -109512,8 +111161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: true content: @@ -109545,9 +111194,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109571,7 +111220,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -109581,9 +111230,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 x-github: @@ -109609,7 +111258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *778 + - *797 - name: role description: Filters members returned by their role in the team. in: query @@ -109632,7 +111281,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -109660,8 +111309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: if user is a member @@ -109697,8 +111346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109737,8 +111386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109774,16 +111423,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '200': description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-user-is-a-team-maintainer: *783 + response-if-user-is-a-team-maintainer: *802 '404': *6 x-github: githubCloudOnly: false @@ -109816,8 +111465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 requestBody: required: false content: @@ -109842,9 +111491,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-users-membership-with-team-is-now-pending: *784 + response-if-users-membership-with-team-is-now-pending: *803 '403': description: Forbidden if team synchronization is set up '422': @@ -109878,8 +111527,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109907,7 +111556,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -109917,9 +111566,9 @@ paths: application/json: schema: type: array - items: *444 + items: *461 examples: - default: *785 + default: *804 headers: Link: *43 '404': *6 @@ -109945,16 +111594,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *778 - - *445 + - *797 + - *462 responses: '200': description: Response content: application/json: - schema: *444 + schema: *461 examples: - default: *786 + default: *805 '404': description: Not Found if project is not managed by this team x-github: @@ -109978,8 +111627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *778 - - *445 + - *797 + - *462 requestBody: required: false content: @@ -110046,8 +111695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *778 - - *445 + - *797 + - *462 responses: '204': description: Response @@ -110074,7 +111723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -110084,9 +111733,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '404': *6 @@ -110116,15 +111765,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *787 + schema: *806 examples: alternative-response-with-extra-repository-information: value: @@ -110275,9 +111924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 requestBody: required: false content: @@ -110327,9 +111976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 responses: '204': description: Response @@ -110358,15 +112007,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *778 + - *797 responses: '200': description: Response content: application/json: - schema: *448 + schema: *465 examples: - default: *449 + default: *466 '403': *29 '404': *6 x-github: @@ -110393,7 +112042,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -110450,7 +112099,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *465 examples: default: value: @@ -110481,7 +112130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -110491,9 +112140,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - response-if-child-teams-exist: *788 + response-if-child-teams-exist: *807 headers: Link: *43 '404': *6 @@ -110526,7 +112175,7 @@ paths: application/json: schema: oneOf: - - &790 + - &809 title: Private User description: Private User type: object @@ -110729,7 +112378,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *789 + - *808 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -110882,7 +112531,7 @@ paths: description: Response content: application/json: - schema: *790 + schema: *809 examples: default: value: @@ -110961,7 +112610,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '304': *37 '404': *6 '403': *29 @@ -110984,7 +112633,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *182 + - *198 responses: '204': description: If the user is blocked @@ -111012,7 +112661,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -111036,7 +112685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -111085,9 +112734,9 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: - default: *348 + default: *366 '304': *37 '500': *40 '401': *25 @@ -111226,21 +112875,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111280,7 +112929,7 @@ paths: type: integer secrets: type: array - items: &791 + items: &810 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -111320,7 +112969,7 @@ paths: - visibility - selected_repositories_url examples: - default: *556 + default: *573 headers: Link: *43 x-github: @@ -111390,13 +113039,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 responses: '200': description: Response content: application/json: - schema: *791 + schema: *810 examples: default: value: @@ -111426,7 +113075,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 requestBody: required: true content: @@ -111471,7 +113120,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -111499,7 +113148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 responses: '204': description: Response @@ -111524,7 +113173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *265 + - *285 responses: '200': description: Response @@ -111540,9 +113189,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *792 + default: *811 '401': *25 '403': *29 '404': *6 @@ -111567,7 +113216,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *265 + - *285 requestBody: required: true content: @@ -111621,7 +113270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *265 + - *285 - name: repository_id in: path required: true @@ -111654,7 +113303,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *265 + - *285 - name: repository_id in: path required: true @@ -111686,15 +113335,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '304': *37 '500': *40 '401': *25 @@ -111720,7 +113369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 requestBody: required: false content: @@ -111750,9 +113399,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 @@ -111774,7 +113423,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '202': *39 '304': *37 @@ -111803,13 +113452,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '202': description: Response content: application/json: - schema: &793 + schema: &812 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -111850,7 +113499,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &794 + default: &813 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -111882,7 +113531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *349 + - *367 - name: export_id in: path required: true @@ -111895,9 +113544,9 @@ paths: description: Response content: application/json: - schema: *793 + schema: *812 examples: - default: *794 + default: *813 '404': *6 x-github: githubCloudOnly: false @@ -111918,7 +113567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *349 + - *367 responses: '200': description: Response @@ -111934,9 +113583,9 @@ paths: type: integer machines: type: array - items: *795 + items: *814 examples: - default: *796 + default: *815 '304': *37 '500': *40 '401': *25 @@ -111965,7 +113614,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *349 + - *367 requestBody: required: true content: @@ -112015,13 +113664,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *459 + repository: *476 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *554 - required: *555 + properties: *571 + required: *572 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -112795,15 +114444,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '304': *37 '500': *40 '400': *14 @@ -112815,7 +114464,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112835,15 +114484,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '500': *40 '401': *25 '403': *29 @@ -112873,9 +114522,9 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: &808 + default: &826 value: - id: 197 name: hello_docker @@ -112976,7 +114625,7 @@ paths: application/json: schema: type: array - items: &797 + items: &816 title: Email description: Email type: object @@ -113041,9 +114690,9 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: - default: &810 + default: &828 value: - email: octocat@github.com verified: true @@ -113118,7 +114767,7 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: default: value: @@ -113228,7 +114877,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '304': *37 @@ -113261,7 +114910,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '304': *37 @@ -113283,7 +114932,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *182 + - *198 responses: '204': description: if the person is followed by the authenticated user @@ -113313,7 +114962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -113338,7 +114987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -113374,7 +115023,7 @@ paths: application/json: schema: type: array - items: &798 + items: &817 title: GPG Key description: A unique encryption key type: object @@ -113505,7 +115154,7 @@ paths: - subkeys - revoked examples: - default: &824 + default: &842 value: - id: 3 name: Octocat's GPG Key @@ -113590,9 +115239,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *817 examples: - default: &799 + default: &818 value: id: 3 name: Octocat's GPG Key @@ -113649,7 +115298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &800 + - &819 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -113661,9 +115310,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *817 examples: - default: *799 + default: *818 '404': *6 '304': *37 '403': *29 @@ -113686,7 +115335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *800 + - *819 responses: '204': description: Response @@ -113875,9 +115524,9 @@ paths: type: string repositories: type: array - items: *69 + items: *74 examples: - default: *250 + default: *270 headers: Link: *43 '404': *6 @@ -113902,7 +115551,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *249 + - *269 responses: '204': description: Response @@ -113928,7 +115577,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *249 + - *269 responses: '204': description: Response @@ -113962,12 +115611,12 @@ paths: application/json: schema: anyOf: - - *337 + - *355 - type: object properties: {} additionalProperties: false examples: - default: *338 + default: *356 '204': description: Response when there are no restrictions x-github: @@ -113991,7 +115640,7 @@ paths: required: true content: application/json: - schema: *635 + schema: *652 examples: default: value: @@ -114002,7 +115651,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: default: value: @@ -114083,7 +115732,7 @@ paths: - closed - all default: open - - *345 + - *363 - name: sort description: What to sort results by. in: query @@ -114095,8 +115744,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -114106,9 +115755,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *346 + default: *364 headers: Link: *43 '404': *6 @@ -114141,7 +115790,7 @@ paths: application/json: schema: type: array - items: &801 + items: &820 title: Key description: Key type: object @@ -114242,9 +115891,9 @@ paths: description: Response content: application/json: - schema: *801 + schema: *820 examples: - default: &802 + default: &821 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -114277,15 +115926,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *663 + - *680 responses: '200': description: Response content: application/json: - schema: *801 + schema: *820 examples: - default: *802 + default: *821 '404': *6 '304': *37 '403': *29 @@ -114308,7 +115957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *663 + - *680 responses: '204': description: Response @@ -114341,7 +115990,7 @@ paths: application/json: schema: type: array - items: &803 + items: &822 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114398,7 +116047,7 @@ paths: - id - type - login - plan: *207 + plan: *224 required: - billing_cycle - next_billing_date @@ -114409,7 +116058,7 @@ paths: - account - plan examples: - default: &804 + default: &823 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114471,9 +116120,9 @@ paths: application/json: schema: type: array - items: *803 + items: *822 examples: - default: *804 + default: *823 headers: Link: *43 '304': *37 @@ -114513,7 +116162,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -114615,13 +116264,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -114679,7 +116328,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *78 + - *83 requestBody: required: true content: @@ -114704,7 +116353,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -114772,7 +116421,7 @@ paths: application/json: schema: type: array - items: *352 + items: *370 examples: default: value: @@ -115025,7 +116674,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -115205,7 +116854,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *353 + - *371 - name: exclude in: query required: false @@ -115218,7 +116867,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -115412,7 +117061,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *353 + - *371 responses: '302': description: Response @@ -115438,7 +117087,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *353 + - *371 responses: '204': description: Response @@ -115467,8 +117116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *353 - - *805 + - *371 + - *824 responses: '204': description: Response @@ -115492,7 +117141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *353 + - *371 - *17 - *19 responses: @@ -115502,9 +117151,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '404': *6 @@ -115539,9 +117188,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: *806 + default: *237 headers: Link: *43 '304': *37 @@ -115583,7 +117232,7 @@ paths: - docker - nuget - container - - *807 + - *825 - *19 - *17 responses: @@ -115593,10 +117242,10 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 - '400': *809 + default: *826 + '400': *827 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115616,16 +117265,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: - default: &825 + default: &843 value: id: 40201 name: octo-name @@ -115738,8 +117387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 responses: '204': description: Response @@ -115769,8 +117418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 - name: token description: package token schema: @@ -115802,8 +117451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 - *19 - *17 - name: state @@ -115823,7 +117472,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -115872,15 +117521,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -115916,9 +117565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '204': description: Response @@ -115948,9 +117597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '204': description: Response @@ -116006,7 +117655,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: default: value: @@ -116078,9 +117727,9 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: - default: *810 + default: *828 headers: Link: *43 '304': *37 @@ -116191,9 +117840,9 @@ paths: application/json: schema: type: array - items: *69 + items: *74 examples: - default: &817 + default: &835 summary: Default response value: - id: 1296269 @@ -116497,9 +118146,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -116537,9 +118186,9 @@ paths: application/json: schema: type: array - items: *637 + items: *654 examples: - default: *811 + default: *829 headers: Link: *43 '304': *37 @@ -116562,12 +118211,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *341 + - *359 responses: '204': description: Response '403': *29 - '409': *109 + '409': *114 '404': *6 '304': *37 x-github: @@ -116585,11 +118234,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *341 + - *359 responses: '204': description: Response - '409': *109 + '409': *114 '304': *37 '404': *6 '403': *29 @@ -116618,7 +118267,7 @@ paths: application/json: schema: type: array - items: &812 + items: &830 title: Social account description: Social media account type: object @@ -116633,7 +118282,7 @@ paths: - provider - url examples: - default: &813 + default: &831 value: - provider: twitter url: https://twitter.com/github @@ -116695,9 +118344,9 @@ paths: application/json: schema: type: array - items: *812 + items: *830 examples: - default: *813 + default: *831 '422': *15 '304': *37 '404': *6 @@ -116784,7 +118433,7 @@ paths: application/json: schema: type: array - items: &814 + items: &832 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -116804,7 +118453,7 @@ paths: - title - created_at examples: - default: &828 + default: &846 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116870,9 +118519,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *832 examples: - default: &815 + default: &833 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116903,7 +118552,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &816 + - &834 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -116915,9 +118564,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *832 examples: - default: *815 + default: *833 '404': *6 '304': *37 '403': *29 @@ -116940,7 +118589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *816 + - *834 responses: '204': description: Response @@ -116969,7 +118618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &829 + - &847 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -116982,7 +118631,7 @@ paths: - created - updated default: created - - *101 + - *106 - *17 - *19 responses: @@ -116992,13 +118641,13 @@ paths: application/json: schema: type: array - items: *69 + items: *74 examples: - default-response: *817 + default-response: *835 application/vnd.github.v3.star+json: schema: type: array - items: &830 + items: &848 title: Starred Repository description: Starred Repository type: object @@ -117006,7 +118655,7 @@ paths: starred_at: type: string format: date-time - repo: *69 + repo: *74 required: - starred_at - repo @@ -117154,8 +118803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response if this repository is starred by you @@ -117183,8 +118832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -117208,8 +118857,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -117242,9 +118891,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '304': *37 @@ -117281,7 +118930,7 @@ paths: application/json: schema: type: array - items: *427 + items: *444 examples: default: value: @@ -117359,7 +119008,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *209 + - *226 responses: '200': description: Response @@ -117367,10 +119016,10 @@ paths: application/json: schema: oneOf: - - *790 - - *789 + - *809 + - *808 examples: - default-response: &819 + default-response: &837 summary: Default response value: login: octocat @@ -117405,7 +119054,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &820 + response-with-git-hub-plan-information: &838 summary: Response with GitHub plan information value: login: octocat @@ -117465,7 +119114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *818 + - *836 - *17 responses: '200': @@ -117476,7 +119125,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: example: ; rel="next" @@ -117506,7 +119155,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *182 + - *198 responses: '200': description: Response @@ -117514,11 +119163,11 @@ paths: application/json: schema: oneOf: - - *790 - - *789 + - *809 + - *808 examples: - default-response: *819 - response-with-git-hub-plan-information: *820 + default-response: *837 + response-with-git-hub-plan-information: *838 '404': *6 x-github: githubCloudOnly: false @@ -117542,9 +119191,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *99 - - *100 - - *182 + - *104 + - *105 + - *198 requestBody: required: true content: @@ -117567,8 +119216,8 @@ paths: required: - subject_digests examples: - default: *821 - withPredicateType: *822 + default: *839 + withPredicateType: *840 responses: '200': description: Response @@ -117621,7 +119270,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *823 + default: *841 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -117639,7 +119288,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *182 + - *198 requestBody: required: true content: @@ -117704,7 +119353,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *182 + - *198 - name: subject_digest description: Subject Digest in: path @@ -117735,7 +119384,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *182 + - *198 - name: attestation_id description: Attestation ID in: path @@ -117771,9 +119420,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *99 - - *100 - - *182 + - *104 + - *105 + - *198 - name: subject_digest description: Subject Digest in: path @@ -117825,12 +119474,12 @@ paths: initiator: type: string examples: - default: *499 + default: *516 '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -117856,7 +119505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *182 + - *198 responses: '200': description: Response @@ -117864,9 +119513,9 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 + default: *826 '403': *29 '401': *25 x-github: @@ -117889,7 +119538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -117899,7 +119548,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -117961,8 +119610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *182 - - *78 + - *198 + - *83 - *17 - *19 responses: @@ -117972,7 +119621,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -118049,7 +119698,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118059,7 +119708,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -118117,7 +119766,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118129,7 +119778,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -118148,7 +119797,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118160,7 +119809,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -118179,7 +119828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *182 + - *198 - name: target_user in: path required: true @@ -118206,8 +119855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *182 - - *196 + - *198 + - *213 - *17 - *19 responses: @@ -118217,9 +119866,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '422': *15 @@ -118240,7 +119889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118250,9 +119899,9 @@ paths: application/json: schema: type: array - items: *798 + items: *817 examples: - default: *824 + default: *842 headers: Link: *43 x-github: @@ -118276,7 +119925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *182 + - *198 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -118348,7 +119997,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *182 + - *198 responses: '200': description: Response @@ -118356,7 +120005,7 @@ paths: application/json: schema: *22 examples: - default: *634 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118374,7 +120023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118429,7 +120078,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118439,9 +120088,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: *806 + default: *237 headers: Link: *43 x-github: @@ -118480,8 +120129,8 @@ paths: - docker - nuget - container - - *807 - - *182 + - *825 + - *198 - *19 - *17 responses: @@ -118491,12 +120140,12 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 + default: *826 '403': *29 '401': *25 - '400': *809 + '400': *827 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118516,17 +120165,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: - default: *825 + default: *843 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118547,9 +120196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '204': description: Response @@ -118581,9 +120230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 - name: token description: package token schema: @@ -118615,9 +120264,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '200': description: Response @@ -118625,7 +120274,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -118683,16 +120332,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *360 - - *361 - - *363 - - *182 + - *378 + - *379 + - *381 + - *198 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -118727,10 +120376,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *360 - - *361 - - *182 - - *363 + - *378 + - *379 + - *198 + - *381 responses: '204': description: Response @@ -118762,10 +120411,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *360 - - *361 - - *182 - - *363 + - *378 + - *379 + - *198 + - *381 responses: '204': description: Response @@ -118791,7 +120440,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *182 + - *198 - name: state description: Indicates the state of the projects to return. in: query @@ -118812,7 +120461,7 @@ paths: application/json: schema: type: array - items: *374 + items: *392 examples: default: value: @@ -118870,15 +120519,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *182 + - *198 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *99 - - *100 + - *104 + - *105 - *17 responses: '200': @@ -118887,9 +120536,9 @@ paths: application/json: schema: type: array - items: *375 + items: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -118911,16 +120560,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *377 - - *182 + - *395 + - *198 responses: '200': description: Response content: application/json: - schema: *375 + schema: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -118942,11 +120591,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *377 - - *182 + - *395 + - *198 - *17 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -118954,9 +120603,9 @@ paths: application/json: schema: type: array - items: *378 + items: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -118978,17 +120627,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *377 - - *826 - - *182 + - *395 + - *844 + - *198 responses: '200': description: Response content: application/json: - schema: *378 + schema: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -119011,10 +120660,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *377 - - *182 - - *99 - - *100 + - *395 + - *198 + - *104 + - *105 - *17 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -119024,16 +120673,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -119041,9 +120693,9 @@ paths: application/json: schema: type: array - items: *385 + items: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -119064,8 +120716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *182 - - *377 + - *198 + - *395 requestBody: required: true description: Details of the item to add to the project. @@ -119102,10 +120754,10 @@ paths: description: Response content: application/json: - schema: *827 + schema: *845 examples: - issue: *384 - pull_request: *384 + issue: *402 + pull_request: *402 '304': *37 '403': *29 '401': *25 @@ -119125,28 +120777,31 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *385 + schema: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -119167,9 +120822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -119239,13 +120894,13 @@ paths: description: Response content: application/json: - schema: *385 + schema: *403 examples: - text_field: *386 - number_field: *386 - date_field: *386 - single_select_field: *386 - iteration_field: *386 + text_field: *404 + number_field: *404 + date_field: *404 + single_select_field: *404 + iteration_field: *404 '401': *25 '403': *29 '404': *6 @@ -119265,9 +120920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 responses: '204': description: Response @@ -119294,7 +120949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119304,7 +120959,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -119369,7 +121024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119379,7 +121034,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -119442,7 +121097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *182 + - *198 - name: type description: Limit results to repositories of the specified type. in: query @@ -119485,9 +121140,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -119511,15 +121166,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *414 + schema: *431 examples: - default: *415 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119541,15 +121196,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119558,7 +121213,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -119566,12 +121224,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - - *182 - - *173 - - *222 - - *174 - - *224 - - *225 + - *198 + - *189 + - *240 + - *190 + - *242 + - *243 responses: '200': description: Response when getting a billing premium request usage report @@ -119624,19 +121282,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -119679,7 +121337,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119701,15 +121359,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *421 + schema: *438 examples: - default: *422 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119729,11 +121387,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *182 - - *173 - - *226 - - *174 - - *227 + - *198 + - *189 + - *244 + - *190 + - *245 responses: '200': description: Response when getting a billing usage report @@ -119804,7 +121462,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119822,7 +121480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119832,9 +121490,9 @@ paths: application/json: schema: type: array - items: *812 + items: *830 examples: - default: *813 + default: *831 headers: Link: *43 x-github: @@ -119854,7 +121512,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119864,9 +121522,9 @@ paths: application/json: schema: type: array - items: *814 + items: *832 examples: - default: *828 + default: *846 headers: Link: *43 x-github: @@ -119890,9 +121548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *182 - - *829 - - *101 + - *198 + - *847 + - *106 - *17 - *19 responses: @@ -119903,11 +121561,11 @@ paths: schema: anyOf: - type: array - items: *830 + items: *848 - type: array - items: *69 + items: *74 examples: - default-response: *817 + default-response: *835 headers: Link: *43 x-github: @@ -119926,7 +121584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119936,9 +121594,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -120066,7 +121724,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &831 + enterprise: &849 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -120124,7 +121782,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &832 + installation: &850 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -120143,7 +121801,7 @@ x-webhooks: required: - id - node_id - organization: &833 + organization: &851 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -120203,13 +121861,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &834 + repository: &852 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &871 + properties: &889 id: description: Unique identifier of the repository example: 42 @@ -120229,8 +121887,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true organization: title: Simple User @@ -120892,7 +122550,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &872 + required: &890 - archive_url - assignees_url - blobs_url @@ -121043,10 +122701,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -121122,11 +122780,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: &835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: &853 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -121349,11 +123007,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: *835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: *853 sender: *4 required: - action @@ -121536,11 +123194,11 @@ x-webhooks: - everyone required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: *835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: *853 sender: *4 required: - action @@ -121611,7 +123269,7 @@ x-webhooks: required: true content: application/json: - schema: &838 + schema: &856 title: Exemption request cancellation event type: object properties: @@ -121619,11 +123277,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: &836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: &854 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -121856,7 +123514,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &837 + items: &855 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -121964,7 +123622,7 @@ x-webhooks: required: true content: application/json: - schema: &839 + schema: &857 title: Exemption request completed event type: object properties: @@ -121972,11 +123630,11 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 sender: *4 required: - action @@ -122046,7 +123704,7 @@ x-webhooks: required: true content: application/json: - schema: &840 + schema: &858 title: Exemption request created event type: object properties: @@ -122054,11 +123712,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 sender: *4 required: - action @@ -122128,7 +123786,7 @@ x-webhooks: required: true content: application/json: - schema: &841 + schema: &859 title: Exemption response dismissed event type: object properties: @@ -122136,12 +123794,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 - exemption_response: *837 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 + exemption_response: *855 sender: *4 required: - action @@ -122213,7 +123871,7 @@ x-webhooks: required: true content: application/json: - schema: &842 + schema: &860 title: Exemption response submitted event type: object properties: @@ -122221,12 +123879,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 - exemption_response: *837 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 + exemption_response: *855 sender: *4 required: - action @@ -122299,7 +123957,7 @@ x-webhooks: required: true content: application/json: - schema: *838 + schema: *856 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122366,7 +124024,7 @@ x-webhooks: required: true content: application/json: - schema: *839 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122433,7 +124091,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122500,7 +124158,7 @@ x-webhooks: required: true content: application/json: - schema: *841 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122568,7 +124226,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122646,7 +124304,7 @@ x-webhooks: type: string enum: - completed - check_run: &844 + check_run: &862 title: CheckRun description: A check performed on the code of a given code change type: object @@ -122699,8 +124357,8 @@ x-webhooks: type: string pull_requests: type: array - items: *194 - repository: *255 + items: *211 + repository: *275 status: example: completed type: string @@ -122737,7 +124395,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *843 + deployment: *861 details_url: example: https://example.com type: string @@ -122787,7 +124445,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *194 + items: *211 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -122822,10 +124480,10 @@ x-webhooks: - output - app - pull_requests - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -123218,11 +124876,11 @@ x-webhooks: type: string enum: - created - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -123618,11 +125276,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 requested_action: description: The action requested by the user. type: object @@ -124027,11 +125685,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -125008,10 +126666,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -125681,10 +127339,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -126348,10 +128006,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -126517,7 +128175,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126662,20 +128320,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &845 + commit_oid: &863 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *831 - installation: *832 - organization: *833 - ref: &846 + enterprise: *849 + installation: *850 + organization: *851 + ref: &864 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -126840,7 +128498,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127070,12 +128728,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127170,7 +128828,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127341,12 +128999,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127512,7 +129170,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127678,12 +129336,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127783,7 +129441,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127951,16 +129609,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *834 + repository: *852 sender: *4 required: - action @@ -128057,7 +129715,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128197,12 +129855,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -128459,10 +130117,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -128542,18 +130200,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *833 - pusher_type: &847 + organization: *851 + pusher_type: &865 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &848 + ref: &866 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -128563,7 +130221,7 @@ x-webhooks: enum: - tag - branch - repository: *834 + repository: *852 sender: *4 required: - ref @@ -128645,10 +130303,10 @@ x-webhooks: type: string enum: - created - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128733,9 +130391,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128812,10 +130470,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128892,10 +130550,10 @@ x-webhooks: type: string enum: - updated - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128972,19 +130630,19 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - repository: *834 - organization: *833 + enterprise: *849 + installation: *850 + repository: *852 + organization: *851 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *389 + items: *144 old_property_values: type: array description: The old custom property values for the repository. - items: *389 + items: *144 required: - action - repository @@ -129060,18 +130718,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - pusher_type: *847 - ref: *848 + enterprise: *849 + installation: *850 + organization: *851 + pusher_type: *865 + ref: *866 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *834 + repository: *852 sender: *4 required: - ref @@ -129155,11 +130813,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129243,11 +130901,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129331,11 +130989,11 @@ x-webhooks: type: string enum: - created - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129417,11 +131075,11 @@ x-webhooks: type: string enum: - dismissed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129503,11 +131161,11 @@ x-webhooks: type: string enum: - fixed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129590,11 +131248,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129676,11 +131334,11 @@ x-webhooks: type: string enum: - reopened - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129757,9 +131415,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - key: &849 + enterprise: *849 + installation: *850 + key: &867 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -129795,8 +131453,8 @@ x-webhooks: - verified - created_at - read_only - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -129873,11 +131531,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - key: *849 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + key: *867 + organization: *851 + repository: *852 sender: *4 required: - action @@ -130438,12 +132096,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: &853 + workflow: &871 title: Workflow type: object nullable: true @@ -131169,13 +132827,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *590 + deployment: *607 pull_requests: type: array - items: *682 - repository: *834 - organization: *833 - installation: *832 + items: *701 + repository: *852 + organization: *851 + installation: *850 sender: *4 responses: '200': @@ -131246,7 +132904,7 @@ x-webhooks: type: string enum: - approved - approver: &850 + approver: &868 type: object properties: avatar_url: @@ -131289,11 +132947,11 @@ x-webhooks: type: string comment: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - reviewers: &851 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + reviewers: &869 type: array items: type: object @@ -131372,7 +133030,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &852 + workflow_job_run: &870 type: object properties: conclusion: @@ -132103,18 +133761,18 @@ x-webhooks: type: string enum: - rejected - approver: *850 + approver: *868 comment: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - reviewers: *851 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + reviewers: *869 sender: *4 since: type: string - workflow_job_run: *852 + workflow_job_run: *870 workflow_job_runs: type: array items: @@ -132818,13 +134476,13 @@ x-webhooks: type: string enum: - requested - enterprise: *831 + enterprise: *849 environment: type: string - installation: *832 - organization: *833 - repository: *834 - requestor: &858 + installation: *850 + organization: *851 + repository: *852 + requestor: &876 title: User type: object nullable: true @@ -134723,12 +136381,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Deployment Workflow Run type: object @@ -135408,7 +137066,7 @@ x-webhooks: type: string enum: - answered - answer: &856 + answer: &874 type: object properties: author_association: @@ -135565,11 +137223,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135696,11 +137354,11 @@ x-webhooks: - from required: - category - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135783,11 +137441,11 @@ x-webhooks: type: string enum: - closed - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135869,7 +137527,7 @@ x-webhooks: type: string enum: - created - comment: &855 + comment: &873 type: object properties: author_association: @@ -136026,11 +137684,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136113,12 +137771,12 @@ x-webhooks: type: string enum: - deleted - comment: *855 - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + comment: *873 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136213,12 +137871,12 @@ x-webhooks: - from required: - body - comment: *855 - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + comment: *873 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136302,11 +137960,11 @@ x-webhooks: type: string enum: - created - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136388,11 +138046,11 @@ x-webhooks: type: string enum: - deleted - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136492,11 +138150,11 @@ x-webhooks: type: string required: - from - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136578,10 +138236,10 @@ x-webhooks: type: string enum: - labeled - discussion: *854 - enterprise: *831 - installation: *832 - label: &857 + discussion: *872 + enterprise: *849 + installation: *850 + label: &875 title: Label type: object properties: @@ -136613,8 +138271,8 @@ x-webhooks: - color - default - description - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136697,11 +138355,11 @@ x-webhooks: type: string enum: - locked - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136783,11 +138441,11 @@ x-webhooks: type: string enum: - pinned - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136869,11 +138527,11 @@ x-webhooks: type: string enum: - reopened - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136958,16 +138616,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *854 - new_repository: *834 + new_discussion: *872 + new_repository: *852 required: - new_discussion - new_repository - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137050,10 +138708,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *854 - old_answer: *856 - organization: *833 - repository: *834 + discussion: *872 + old_answer: *874 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137135,12 +138793,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *854 - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137223,11 +138881,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137309,11 +138967,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137382,7 +139040,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137445,7 +139103,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137511,7 +139169,7 @@ x-webhooks: required: true content: application/json: - schema: *838 + schema: *856 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137577,7 +139235,7 @@ x-webhooks: required: true content: application/json: - schema: *839 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137643,7 +139301,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137709,7 +139367,7 @@ x-webhooks: required: true content: application/json: - schema: *841 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137775,7 +139433,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137842,7 +139500,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *831 + enterprise: *849 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -138502,9 +140160,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *832 - organization: *833 - repository: *834 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - forkee @@ -138650,9 +140308,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pages: description: The pages that were updated. type: array @@ -138689,7 +140347,7 @@ x-webhooks: - action - sha - html_url - repository: *834 + repository: *852 sender: *4 required: - pages @@ -138765,10 +140423,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: &859 + organization: *851 + repositories: &877 description: An array of repository objects that the installation can access. type: array @@ -138794,8 +140452,8 @@ x-webhooks: - name - full_name - private - repository: *834 - requester: *858 + repository: *852 + requester: *876 sender: *4 required: - action @@ -138870,11 +140528,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -138950,11 +140608,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139030,10 +140688,10 @@ x-webhooks: type: string enum: - added - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories_added: &860 + organization: *851 + repositories_added: &878 description: An array of repository objects, which were added to the installation. type: array @@ -139079,15 +140737,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *834 - repository_selection: &861 + repository: *852 + repository_selection: &879 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *858 + requester: *876 sender: *4 required: - action @@ -139166,10 +140824,10 @@ x-webhooks: type: string enum: - removed - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories_added: *860 + organization: *851 + repositories_added: *878 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -139196,9 +140854,9 @@ x-webhooks: - name - full_name - private - repository: *834 - repository_selection: *861 - requester: *858 + repository: *852 + repository_selection: *879 + requester: *876 sender: *4 required: - action @@ -139277,11 +140935,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139460,10 +141118,10 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 target_type: type: string @@ -139542,11 +141200,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139670,8 +141328,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 reactions: title: Reactions type: object @@ -139798,8 +141456,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -140593,8 +142251,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140610,7 +142268,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -140943,8 +142601,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -141024,7 +142682,7 @@ x-webhooks: type: string enum: - deleted - comment: &862 + comment: &880 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -141189,8 +142847,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -141980,8 +143638,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141997,7 +143655,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -142332,8 +143990,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -142413,7 +144071,7 @@ x-webhooks: type: string enum: - edited - changes: &891 + changes: &909 description: The changes to the comment. type: object properties: @@ -142425,9 +144083,9 @@ x-webhooks: type: string required: - from - comment: *862 - enterprise: *831 - installation: *832 + comment: *880 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143220,8 +144878,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143237,7 +144895,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -143570,8 +145228,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143655,15 +145313,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 + blocked_issue: *206 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - blocking_issue_repo: *69 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + blocking_issue_repo: *74 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143751,15 +145409,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 + blocked_issue: *206 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - blocking_issue_repo: *69 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + blocking_issue_repo: *74 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143846,15 +145504,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 - blocked_issue_repo: *69 + blocked_issue: *206 + blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143942,15 +145600,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 - blocked_issue_repo: *69 + blocked_issue: *206 + blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -144035,10 +145693,10 @@ x-webhooks: type: string enum: - assigned - assignee: *858 - enterprise: *831 - installation: *832 - issue: &865 + assignee: *876 + enterprise: *849 + installation: *850 + issue: &883 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -144827,11 +146485,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144847,7 +146505,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -144948,8 +146606,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -145029,8 +146687,8 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -145824,11 +147482,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145844,7 +147502,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -146080,8 +147738,8 @@ x-webhooks: required: - state - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -146160,8 +147818,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -146946,11 +148604,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146966,7 +148624,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -147066,8 +148724,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -147146,8 +148804,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147954,11 +149612,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147974,7 +149632,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -148053,7 +149711,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &863 + milestone: &881 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148191,8 +149849,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -148291,8 +149949,8 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149081,11 +150739,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149098,7 +150756,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -149202,9 +150860,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *857 - organization: *833 - repository: *834 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -149284,8 +150942,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150073,11 +151731,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150090,7 +151748,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -150194,9 +151852,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *857 - organization: *833 - repository: *834 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -150276,8 +151934,8 @@ x-webhooks: type: string enum: - locked - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151089,11 +152747,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151106,7 +152764,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -151187,8 +152845,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -151267,8 +152925,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152074,11 +153732,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152094,7 +153752,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -152172,9 +153830,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *863 - organization: *833 - repository: *834 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -153042,11 +154700,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153139,7 +154797,7 @@ x-webhooks: required: - login - id - type: *342 + type: *360 required: - id - number @@ -153608,8 +155266,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154398,11 +156056,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154418,7 +156076,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -154518,8 +156176,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -154599,9 +156257,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *831 - installation: *832 - issue: &864 + enterprise: *849 + installation: *850 + issue: &882 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -155384,11 +157042,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155404,7 +157062,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -155504,8 +157162,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -155584,8 +157242,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156395,11 +158053,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156493,9 +158151,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *342 - organization: *833 - repository: *834 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -157361,11 +159019,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157381,7 +159039,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -157949,11 +159607,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *831 - installation: *832 - issue: *864 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *882 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158033,12 +159691,12 @@ x-webhooks: type: string enum: - typed - enterprise: *831 - installation: *832 - issue: *865 - type: *342 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158119,7 +159777,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &894 + assignee: &912 title: User type: object nullable: true @@ -158189,11 +159847,11 @@ x-webhooks: required: - login - id - enterprise: *831 - installation: *832 - issue: *865 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158272,12 +159930,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *831 - installation: *832 - issue: *865 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158357,8 +160015,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159168,11 +160826,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159188,7 +160846,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -159266,8 +160924,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159347,11 +161005,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *831 - installation: *832 - issue: *864 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *882 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159430,12 +161088,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *831 - installation: *832 - issue: *865 - type: *342 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159515,11 +161173,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159597,11 +161255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159711,11 +161369,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159797,9 +161455,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: &866 + enterprise: *849 + installation: *850 + marketplace_purchase: &884 title: Marketplace Purchase type: object required: @@ -159882,8 +161540,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *833 - previous_marketplace_purchase: &867 + organization: *851 + previous_marketplace_purchase: &885 title: Marketplace Purchase type: object properties: @@ -159963,7 +161621,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160043,10 +161701,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160129,7 +161787,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160211,10 +161869,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160296,7 +161954,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160377,8 +162035,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 marketplace_purchase: title: Marketplace Purchase type: object @@ -160460,9 +162118,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *833 - previous_marketplace_purchase: *867 - repository: *834 + organization: *851 + previous_marketplace_purchase: *885 + repository: *852 sender: *4 required: - action @@ -160542,12 +162200,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 - previous_marketplace_purchase: *867 - repository: *834 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 + previous_marketplace_purchase: *885 + repository: *852 sender: *4 required: - action @@ -160649,11 +162307,11 @@ x-webhooks: type: string required: - to - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160753,11 +162411,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160836,11 +162494,11 @@ x-webhooks: type: string enum: - removed - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160918,11 +162576,11 @@ x-webhooks: type: string enum: - added - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 scope: description: The scope of the membership. Currently, can only be `team`. @@ -160998,7 +162656,7 @@ x-webhooks: required: - login - id - team: &868 + team: &886 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -161221,11 +162879,11 @@ x-webhooks: type: string enum: - removed - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161302,7 +162960,7 @@ x-webhooks: required: - login - id - team: *868 + team: *886 required: - action - scope @@ -161384,8 +163042,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *832 - merge_group: &870 + installation: *850 + merge_group: &888 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -161404,15 +163062,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *869 + head_commit: *887 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161498,10 +163156,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *832 - merge_group: *870 - organization: *833 - repository: *834 + installation: *850 + merge_group: *888 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161574,7 +163232,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 + enterprise: *849 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -161683,16 +163341,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *832 - organization: *833 + installation: *850 + organization: *851 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -161773,11 +163431,11 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161856,9 +163514,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - milestone: &873 + enterprise: *849 + installation: *850 + milestone: &891 title: Milestone description: A collection of related issues and pull requests. type: object @@ -161995,8 +163653,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162075,11 +163733,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162189,11 +163847,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162273,11 +163931,11 @@ x-webhooks: type: string enum: - opened - enterprise: *831 - installation: *832 - milestone: *873 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *891 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162356,11 +164014,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *858 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + blocked_user: *876 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162439,11 +164097,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *858 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + blocked_user: *876 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162462,6 +164120,320 @@ x-webhooks: - organization - business - app + organization-custom-property-created: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: A new organization custom property was created. + operationId: organization-custom-property/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: *139 + enterprise: *849 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-deleted: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was deleted. + operationId: organization-custom-property/deleted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + enterprise: *849 + installation: *850 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-updated: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was updated. + operationId: organization-custom-property/updated + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: *139 + enterprise: *849 + installation: *850 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-values-updated: + post: + summary: This event occurs when there is activity relating to custom property + values for an organization. + description: The custom property values of an organization were updated. + operationId: organization-custom-property-values/updated + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: *849 + installation: *850 + organization: *851 + sender: *4 + new_property_values: + type: array + description: The new custom property values. + items: *144 + old_property_values: + type: array + description: The old custom property values. + items: *144 + required: + - action + - organization + - enterprise + - new_property_values + - old_property_values + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization-custom-property-values + supported-webhook-types: + - business + - organization + - app organization-deleted: post: summary: |- @@ -162522,9 +164494,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - membership: &874 + enterprise: *849 + installation: *850 + membership: &892 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -162631,8 +164603,8 @@ x-webhooks: - role - organization_url - user - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162710,11 +164682,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162793,8 +164765,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -162910,10 +164882,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 - user: *858 + user: *876 required: - action - invitation @@ -162991,11 +164963,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -163082,11 +165054,11 @@ x-webhooks: properties: from: type: string - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -163162,9 +165134,9 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 package: description: Information about the package. type: object @@ -163663,7 +165635,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &875 + items: &893 title: Ruby Gems metadata type: object properties: @@ -163758,7 +165730,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -163834,9 +165806,9 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 package: description: Information about the package. type: object @@ -164189,7 +166161,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *875 + items: *893 source_url: type: string format: uri @@ -164259,7 +166231,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -164436,12 +166408,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *831 + enterprise: *849 id: type: integer - installation: *832 - organization: *833 - repository: *834 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - id @@ -164518,7 +166490,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &876 + personal_access_token_request: &894 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -164664,10 +166636,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *831 - organization: *833 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164744,11 +166716,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *876 - enterprise: *831 - organization: *833 + personal_access_token_request: *894 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164824,11 +166796,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *876 - enterprise: *831 - organization: *833 + personal_access_token_request: *894 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164903,11 +166875,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *876 - organization: *833 - enterprise: *831 + personal_access_token_request: *894 + organization: *851 + enterprise: *849 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -165012,7 +166984,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *877 + last_response: *895 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -165044,8 +167016,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 zen: description: Random string of GitHub zen. @@ -165290,10 +167262,10 @@ x-webhooks: - from required: - note - enterprise: *831 - installation: *832 - organization: *833 - project_card: &878 + enterprise: *849 + installation: *850 + organization: *851 + project_card: &896 title: Project Card type: object properties: @@ -165412,7 +167384,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -165493,11 +167465,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project_card: *878 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_card: *896 + repository: *852 sender: *4 required: - action @@ -165577,9 +167549,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 project_card: title: Project Card type: object @@ -165707,8 +167679,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -165802,11 +167774,11 @@ x-webhooks: - from required: - note - enterprise: *831 - installation: *832 - organization: *833 - project_card: *878 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_card: *896 + repository: *852 sender: *4 required: - action @@ -165900,9 +167872,9 @@ x-webhooks: - from required: - column_id - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 project_card: allOf: - title: Project Card @@ -166092,7 +168064,7 @@ x-webhooks: type: string required: - after_id - repository: *834 + repository: *852 sender: *4 required: - action @@ -166172,10 +168144,10 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - organization: *833 - project: &880 + enterprise: *849 + installation: *850 + organization: *851 + project: &898 title: Project type: object properties: @@ -166299,7 +168271,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -166379,10 +168351,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project_column: &879 + enterprise: *849 + installation: *850 + organization: *851 + project_column: &897 title: Project Column type: object properties: @@ -166421,7 +168393,7 @@ x-webhooks: - name - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -166500,18 +168472,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -166601,11 +168573,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 + repository: *852 sender: *4 required: - action @@ -166685,11 +168657,11 @@ x-webhooks: type: string enum: - moved - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 + repository: *852 sender: *4 required: - action @@ -166769,11 +168741,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -166853,18 +168825,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - project: *880 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -166966,11 +168938,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -167049,11 +169021,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -167134,9 +169106,9 @@ x-webhooks: type: string enum: - closed - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167217,9 +169189,9 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167300,9 +169272,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167419,9 +169391,9 @@ x-webhooks: type: string to: type: string - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167504,7 +169476,7 @@ x-webhooks: type: string enum: - archived - changes: &884 + changes: &902 type: object properties: archived_at: @@ -167518,9 +169490,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *832 - organization: *833 - projects_v2_item: &881 + installation: *850 + organization: *851 + projects_v2_item: &899 title: Projects v2 Item description: An item belonging to a project type: object @@ -167538,7 +169510,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *383 + content_type: *401 creator: *4 created_at: type: string @@ -167655,9 +169627,9 @@ x-webhooks: nullable: true to: type: string - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167739,9 +169711,9 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167822,9 +169794,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167930,7 +169902,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &882 + - &900 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -167952,7 +169924,7 @@ x-webhooks: required: - id - name - - &883 + - &901 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -167986,8 +169958,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *882 - - *883 + - *900 + - *901 required: - field_value - type: object @@ -168003,9 +169975,9 @@ x-webhooks: nullable: true required: - body - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168100,9 +170072,9 @@ x-webhooks: to: type: string nullable: true - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168185,10 +170157,10 @@ x-webhooks: type: string enum: - restored - changes: *884 - installation: *832 - organization: *833 - projects_v2_item: *881 + changes: *902 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168270,9 +170242,9 @@ x-webhooks: type: string enum: - reopened - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -168353,14 +170325,14 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2_status_update: &887 + installation: *850 + organization: *851 + projects_v2_status_update: &905 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *885 - required: *886 + properties: *903 + required: *904 sender: *4 required: - action @@ -168441,9 +170413,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2_status_update: *887 + installation: *850 + organization: *851 + projects_v2_status_update: *905 sender: *4 required: - action @@ -168579,9 +170551,9 @@ x-webhooks: type: string format: date nullable: true - installation: *832 - organization: *833 - projects_v2_status_update: *887 + installation: *850 + organization: *851 + projects_v2_status_update: *905 sender: *4 required: - action @@ -168652,10 +170624,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - repository @@ -168732,13 +170704,13 @@ x-webhooks: type: string enum: - assigned - assignee: *858 - enterprise: *831 - installation: *832 - number: &888 + assignee: *876 + enterprise: *849 + installation: *850 + number: &906 description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -171021,7 +172993,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -171103,11 +173075,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -173385,7 +175357,7 @@ x-webhooks: - draft reason: type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -173467,11 +175439,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -175749,7 +177721,7 @@ x-webhooks: - draft reason: type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -175831,13 +177803,13 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: &889 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: &907 allOf: - - *682 + - *701 - type: object properties: allow_auto_merge: @@ -175899,7 +177871,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *834 + repository: *852 sender: *4 required: - action @@ -175980,12 +177952,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -176065,11 +178037,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *831 - milestone: *666 - number: *888 - organization: *833 - pull_request: &890 + enterprise: *849 + milestone: *683 + number: *906 + organization: *851 + pull_request: &908 title: Pull Request type: object properties: @@ -178332,7 +180304,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -178411,11 +180383,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -180697,7 +182669,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *834 + repository: *852 sender: *4 required: - action @@ -180821,12 +182793,12 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -180906,11 +182878,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -183177,7 +185149,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -183257,11 +185229,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *831 - installation: *832 - label: *857 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + label: *875 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -185543,7 +187515,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -185624,10 +187596,10 @@ x-webhooks: type: string enum: - locked - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -187907,7 +189879,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -187987,12 +189959,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *831 - milestone: *666 - number: *888 - organization: *833 - pull_request: *890 - repository: *834 + enterprise: *849 + milestone: *683 + number: *906 + organization: *851 + pull_request: *908 + repository: *852 sender: *4 required: - action @@ -188071,12 +190043,12 @@ x-webhooks: type: string enum: - opened - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188157,12 +190129,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188242,12 +190214,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188613,9 +190585,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -190785,7 +192757,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -190865,7 +192837,7 @@ x-webhooks: type: string enum: - deleted - comment: &892 + comment: &910 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -191150,9 +193122,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -193310,7 +195282,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -193390,11 +195362,11 @@ x-webhooks: type: string enum: - edited - changes: *891 - comment: *892 - enterprise: *831 - installation: *832 - organization: *833 + changes: *909 + comment: *910 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -195555,7 +197527,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -195636,9 +197608,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -197811,7 +199783,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 review: description: The review that was affected. type: object @@ -198058,9 +200030,9 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -200114,8 +202086,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 - review: &893 + repository: *852 + review: &911 description: The review that was affected. type: object properties: @@ -200348,12 +202320,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -202636,7 +204608,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_reviewer: title: User type: object @@ -202720,12 +204692,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -205015,7 +206987,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205207,12 +207179,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -207497,7 +209469,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_reviewer: title: User type: object @@ -207582,12 +209554,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -209863,7 +211835,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210044,9 +212016,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -212221,8 +214193,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 - review: *893 + repository: *852 + review: *911 sender: *4 required: - action @@ -212302,9 +214274,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -214374,7 +216346,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 sender: *4 thread: type: object @@ -214761,9 +216733,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -216819,7 +218791,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 sender: *4 thread: type: object @@ -217209,10 +219181,10 @@ x-webhooks: type: string before: type: string - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -219483,7 +221455,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -219565,11 +221537,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *894 - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + assignee: *912 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -221852,7 +223824,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -221931,11 +223903,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *831 - installation: *832 - label: *857 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + label: *875 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -224208,7 +226180,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -224289,10 +226261,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -226557,7 +228529,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -226757,7 +228729,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *831 + enterprise: *849 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -226849,8 +228821,8 @@ x-webhooks: - url - author - committer - installation: *832 - organization: *833 + installation: *850 + organization: *851 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -227425,9 +229397,9 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 registry_package: type: object properties: @@ -227873,7 +229845,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *875 + items: *893 summary: type: string tag_name: @@ -227927,7 +229899,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -228005,9 +229977,9 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 registry_package: type: object properties: @@ -228315,7 +230287,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *875 + items: *893 summary: type: string tag_name: @@ -228364,7 +230336,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -228441,10 +230413,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - release: &895 + enterprise: *849 + installation: *850 + organization: *851 + release: &913 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -228762,7 +230734,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *834 + repository: *852 sender: *4 required: - action @@ -228839,11 +230811,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -228960,11 +230932,11 @@ x-webhooks: type: boolean required: - to - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -229042,9 +231014,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -229366,7 +231338,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *834 + repository: *852 sender: *4 required: - action @@ -229442,10 +231414,10 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - release: &896 + enterprise: *849 + installation: *850 + organization: *851 + release: &914 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -229764,7 +231736,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *834 + repository: *852 sender: *4 required: - action @@ -229840,11 +231812,11 @@ x-webhooks: type: string enum: - released - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -229920,11 +231892,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *831 - installation: *832 - organization: *833 - release: *896 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *914 + repository: *852 sender: *4 required: - action @@ -230000,11 +231972,11 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_advisory: *735 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_advisory: *754 sender: *4 required: - action @@ -230080,11 +232052,11 @@ x-webhooks: type: string enum: - reported - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_advisory: *735 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_advisory: *754 sender: *4 required: - action @@ -230160,10 +232132,10 @@ x-webhooks: type: string enum: - archived - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230240,10 +232212,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230321,10 +232293,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230408,10 +232380,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230523,10 +232495,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230598,10 +232570,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 status: type: string @@ -230682,10 +232654,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230762,10 +232734,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230859,10 +232831,10 @@ x-webhooks: - name required: - repository - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230942,11 +232914,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 sender: *4 required: - action @@ -231024,11 +232996,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 sender: *4 required: - action @@ -231106,11 +233078,11 @@ x-webhooks: type: string enum: - edited - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 changes: type: object properties: @@ -231129,16 +233101,16 @@ x-webhooks: properties: added: type: array - items: *136 + items: *150 deleted: type: array - items: *136 + items: *150 updated: type: array items: type: object properties: - condition: *136 + condition: *150 changes: type: object properties: @@ -231171,16 +233143,16 @@ x-webhooks: properties: added: type: array - items: *703 + items: *722 deleted: type: array - items: *703 + items: *722 updated: type: array items: type: object properties: - rule: *703 + rule: *722 changes: type: object properties: @@ -231414,10 +233386,10 @@ x-webhooks: - from required: - owner - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231495,10 +233467,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231576,7 +233548,7 @@ x-webhooks: type: string enum: - create - alert: &897 + alert: &915 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -231697,10 +233669,10 @@ x-webhooks: type: string enum: - open - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231906,10 +233878,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231987,11 +233959,11 @@ x-webhooks: type: string enum: - reopen - alert: *897 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *915 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232190,10 +234162,10 @@ x-webhooks: enum: - fixed - open - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232271,11 +234243,11 @@ x-webhooks: type: string enum: - created - alert: &898 + alert: &916 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -232283,8 +234255,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri @@ -232389,10 +234361,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232473,11 +234445,11 @@ x-webhooks: type: string enum: - created - alert: *898 - installation: *832 - location: *899 - organization: *833 - repository: *834 + alert: *916 + installation: *850 + location: *917 + organization: *851 + repository: *852 sender: *4 required: - location @@ -232715,11 +234687,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232797,11 +234769,11 @@ x-webhooks: type: string enum: - reopened - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232879,11 +234851,11 @@ x-webhooks: type: string enum: - resolved - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232961,11 +234933,11 @@ x-webhooks: type: string enum: - validated - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -233091,10 +235063,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *834 - enterprise: *831 - installation: *832 - organization: *833 + repository: *852 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -233172,11 +235144,11 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - security_advisory: &900 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + security_advisory: &918 description: The details of the security advisory, including summary, description, and severity. type: object @@ -233192,7 +235164,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array items: @@ -233359,11 +235331,11 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - security_advisory: *900 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + security_advisory: *918 sender: *4 required: - action @@ -233436,10 +235408,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -233456,7 +235428,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array items: @@ -233623,11 +235595,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *392 - enterprise: *831 - installation: *832 - organization: *833 - repository: *459 + security_and_analysis: *409 + enterprise: *849 + installation: *850 + organization: *851 + repository: *476 sender: *4 required: - changes @@ -233705,12 +235677,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: &901 + sponsorship: &919 type: object properties: created_at: @@ -234011,12 +235983,12 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - sponsorship @@ -234104,12 +236076,12 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234186,17 +236158,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &902 + effective_date: &920 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - sponsorship @@ -234270,7 +236242,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &903 + changes: &921 type: object properties: tier: @@ -234314,13 +236286,13 @@ x-webhooks: - from required: - tier - effective_date: *902 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + effective_date: *920 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234397,13 +236369,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *903 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + changes: *921 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234477,10 +236449,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234563,10 +236535,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234986,15 +236958,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *831 + enterprise: *849 id: description: The unique identifier of the status. type: integer - installation: *832 + installation: *850 name: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 sha: description: The Commit SHA. @@ -235103,15 +237075,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - parent_issue_repo: *69 + parent_issue: *206 + parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - installation: *832 - organization: *833 - repository: *834 + sub_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235195,15 +237167,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - parent_issue_repo: *69 + parent_issue: *206 + parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - installation: *832 - organization: *833 - repository: *834 + sub_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235287,15 +237259,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - sub_issue_repo: *69 + sub_issue: *206 + sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - installation: *832 - organization: *833 - repository: *834 + parent_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235379,15 +237351,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - sub_issue_repo: *69 + sub_issue: *206 + sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - installation: *832 - organization: *833 - repository: *834 + parent_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235464,12 +237436,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - team: &904 + team: &922 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -235692,9 +237664,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -236152,7 +238124,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -236228,9 +238200,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -236688,7 +238660,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -236765,9 +238737,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -237225,7 +239197,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -237369,9 +239341,9 @@ x-webhooks: - from required: - permissions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -237829,7 +239801,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - changes @@ -237907,9 +239879,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -238367,7 +240339,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -238443,10 +240415,10 @@ x-webhooks: type: string enum: - started - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -238519,16 +240491,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *831 + enterprise: *849 inputs: type: object nullable: true additionalProperties: true - installation: *832 - organization: *833 + installation: *850 + organization: *851 ref: type: string - repository: *834 + repository: *852 sender: *4 workflow: type: string @@ -238610,10 +240582,10 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: allOf: @@ -238850,7 +240822,7 @@ x-webhooks: type: string required: - conclusion - deployment: *590 + deployment: *607 required: - action - repository @@ -238929,10 +240901,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: allOf: @@ -239192,7 +241164,7 @@ x-webhooks: required: - status - steps - deployment: *590 + deployment: *607 required: - action - repository @@ -239271,10 +241243,10 @@ x-webhooks: type: string enum: - queued - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: type: object @@ -239409,7 +241381,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *590 + deployment: *607 required: - action - repository @@ -239488,10 +241460,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: type: object @@ -239627,7 +241599,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *590 + deployment: *607 required: - action - repository @@ -239707,12 +241679,12 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object @@ -240711,12 +242683,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object @@ -241700,12 +243672,12 @@ x-webhooks: type: string enum: - requested - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index c2fc1bc49..3f38c5702 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -188,6 +188,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -4898,6 +4902,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -5096,6 +5108,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -5858,6 +5879,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6056,6 +6085,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -6672,6 +6710,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -6870,6 +6916,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -7117,6 +7172,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -7315,6 +7378,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -9117,6 +9189,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -9315,6 +9395,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -10128,6 +10217,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -10326,6 +10423,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -11056,6 +11162,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11254,6 +11368,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -11695,6 +11818,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -11893,6 +12024,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -17348,6 +17488,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -17451,6 +17596,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -17591,6 +17740,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -17611,6 +17765,11 @@ "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean", "default": false + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -17690,6 +17849,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -17793,6 +17957,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -17848,17 +18016,17 @@ } } }, - "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": { "get": { - "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", - "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-github-owned-images-for-enterprise", + "summary": "List custom images for an enterprise", + "description": "List custom images for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-images-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" }, "parameters": [ { @@ -17889,46 +18057,60 @@ "images": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "type": "integer", + "example": 1 }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, - "size_gb": { - "description": "Image size in GB.", + "total_versions_size": { + "description": "Total size of all the image versions in GB.", "type": "integer", - "example": 86 + "example": 200 }, - "display_name": { + "name": { "description": "Display name for this image.", "type": "string", - "example": 20.04 + "example": "CustomImage" }, "source": { "description": "The image provider.", "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" } }, "required": [ "id", "platform", - "size_gb", - "display_name", - "source" + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" ] } } @@ -17937,11 +18119,141 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get an enterprise custom image definition for GitHub Actions Hosted Runners", + "description": "Get an enterprise custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" } } } @@ -17955,21 +18267,73 @@ "category": "actions", "subcategory": "hosted-runners" } + }, + "delete": { + "summary": "Delete a custom image from the enterprise", + "description": "Delete a custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } } }, - "/enterprises/{enterprise}/actions/hosted-runners/images/partner": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { "get": { - "summary": "Get partner images for GitHub-hosted runners in an enterprise", - "description": "Get the list of partner images available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-partner-images-for-enterprise", + "summary": "List image versions of a custom image for an enterprise", + "description": "List image versions of a custom image for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], + "operationId": "actions/list-custom-image-versions-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" }, "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "enterprise", "description": "The slug version of the enterprise name.", @@ -17989,55 +18353,51 @@ "type": "object", "required": [ "total_count", - "images" + "image_versions" ], "properties": { "total_count": { "type": "integer" }, - "images": { + "image_versions": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "version": { + "description": "The version of image.", "type": "string", - "example": "ubuntu-20.04" + "example": "1.0.0" }, - "platform": { - "description": "The operating system of the image.", + "state": { + "description": "The state of image version.", "type": "string", - "example": "linux-x64" + "example": "Ready" }, "size_gb": { - "description": "Image size in GB.", + "description": "Image version size in GB.", "type": "integer", - "example": 86 + "example": 30 }, - "display_name": { - "description": "Display name for this image.", + "created_on": { + "description": "The creation date time of the image version.", "type": "string", - "example": 20.04 + "example": "2024-11-09T23:39:01Z" }, - "source": { - "description": "The image provider.", + "state_details": { + "description": "The image version status details.", "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "example": "None" } }, "required": [ - "id", - "platform", + "version", + "state", "size_gb", - "display_name", - "source" + "created_on", + "state_details" ] } } @@ -18046,11 +18406,21 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] } } } @@ -18066,17 +18436,17 @@ } } }, - "/enterprises/{enterprise}/actions/hosted-runners/limits": { + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { "get": { - "summary": "Get limits on GitHub-hosted runners for an enterprise", - "description": "Get the GitHub-hosted runners limits for an enterprise.", + "summary": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/get-hosted-runners-limits-for-enterprise", + "operationId": "actions/get-custom-image-version-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { @@ -18087,6 +18457,25 @@ "schema": { "type": "string" } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } } ], "responses": { @@ -18095,41 +18484,51 @@ "content": { "application/json": { "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { - "public_ips": { - "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", - "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", - "type": "object", - "properties": { - "maximum": { - "type": "integer", - "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" } }, "required": [ - "public_ips" + "version", + "state", + "size_gb", + "created_on", + "state_details" ] }, "examples": { "default": { "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" } } } @@ -18143,19 +18542,369 @@ "category": "actions", "subcategory": "hosted-runners" } + }, + "delete": { + "summary": "Delete an image version of custom image from the enterprise", + "description": "Delete an image version of custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } } }, - "/enterprises/{enterprise}/actions/hosted-runners/machine-sizes": { + "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { "get": { - "summary": "Get GitHub-hosted runners machine specs for an enterprise", - "description": "Get the list of machine specs available for GitHub-hosted runners for an enterprise.", - "operationId": "actions/get-hosted-runners-machine-specs-for-enterprise", + "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-enterprise", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an enterprise", + "description": "Get the list of partner images available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-partner-images-for-enterprise", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an enterprise", + "description": "Get the GitHub-hosted runners limits for an enterprise.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runners-limits-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an enterprise", + "description": "Get the list of machine specs available for GitHub-hosted runners for an enterprise.", + "operationId": "actions/get-hosted-runners-machine-specs-for-enterprise", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise" }, "parameters": [ { @@ -18397,6 +19146,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -18500,6 +19254,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -18615,6 +19373,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -18684,6 +19447,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -18787,6 +19555,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -18925,6 +19697,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -19028,6 +19805,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -26604,6 +27385,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -26802,6 +27591,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -27359,6 +28157,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -27557,6 +28363,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -28270,6 +29085,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -28468,6 +29291,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -29572,6 +30404,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -29770,6 +30610,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -41054,6 +41903,654 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": { + "get": { + "summary": "Get Copilot enterprise usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": { + "get": { + "summary": "Get Copilot enterprise usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -41195,29 +42692,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -44440,17 +45914,17 @@ } } }, - "/enterprises/{enterprise}/properties/schema": { + "/enterprises/{enterprise}/org-properties/schema": { "get": { - "summary": "Get custom properties for an enterprise", - "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "summary": "Get organization custom properties schema for an enterprise", + "description": "Gets all organization custom property definitions that are defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", "tags": [ "enterprise-admin" ], - "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" }, "parameters": [ { @@ -44471,121 +45945,132 @@ "schema": { "type": "array", "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "example": "organization" - }, - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { "type": "array", "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" + } }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": "string", - "nullable": true, - "enum": [ - "org_actors", - "org_and_repo_actors" - ], - "example": "org_actors", - "description": "Who can edit the values of the property" + "required": [ + "property_name", + "value_type" + ] } - }, - "required": [ - "property_name", - "value_type" ] } }, "examples": { "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } } } } @@ -44648,19 +46133,19 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "custom-properties-for-orgs" } }, "patch": { - "summary": "Create or update custom properties for an enterprise", - "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "summary": "Create or update organization custom property definitions on an enterprise", + "description": "Creates new or updates existing organization custom properties defined on an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", "tags": [ "enterprise-admin" ], - "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" }, "parameters": [ { @@ -44682,89 +46167,1801 @@ "properties": { "properties": { "type": "array", - "description": "The array of custom properties to create or update.", + "description": "The array of organization custom properties to create or update.", "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "example": "organization" - }, - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { "type": "array", "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" + } }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": "string", - "nullable": true, - "enum": [ - "org_actors", - "org_and_repo_actors" - ], - "example": "org_actors", - "description": "Who can edit the values of the property" + "required": [ + "property_name", + "value_type" + ] } - }, - "required": [ - "property_name", - "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + } + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": { + "get": { + "summary": "Get an organization custom property definition from an enterprise", + "description": "Gets an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "put": { + "summary": "Create or update an organization custom property definition on an enterprise", + "description": "Creates a new or updates an existing organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property Payload", + "description": "Payload for creating or updating an organization custom property definition on an enterprise.", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property." + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property." + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property." + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property." + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "delete": { + "summary": "Remove an organization custom property definition from an enterprise", + "description": "Removes an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/values": { + "get": { + "summary": "List custom property values for organizations in an enterprise", + "description": "Lists enterprise organizations with all of their custom property values.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Enterprise Organization Custom Property Values", + "description": "List of custom property values for an organization", + "type": "object", + "properties": { + "organization_id": { + "type": "integer", + "example": 1296269 + }, + "organization_login": { + "type": "string", + "example": "Hello-World" + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "organization_id", + "organization_login", + "properties" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "organization_id": 1296269, + "organization_login": "Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for organizations in an enterprise", + "description": "Create or update custom property values for organizations in an enterprise.\n\nTo remove a custom property value from an organization, set the property value to `null`.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"edit enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization_logins": { + "type": "array", + "description": "The names of organizations that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the organizations.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "organization_logins", + "properties" + ] + }, + "examples": { + "default": { + "value": { + "organization_logins": [ + "acme", + "github" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/properties/schema": { + "get": { + "summary": "Get custom properties for an enterprise", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-repos-get-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an enterprise", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" ] }, "minItems": 1, @@ -45988,72 +49185,406 @@ }, { "type": "object", - "title": "organization_name_and_repository_property", - "description": "Conditions to target organizations by name and repositories by property", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", "allOf": [ { - "title": "Repository ruleset conditions for organization names", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization name condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_name": { + "organization_property": { "type": "object", "properties": { "include": { "type": "array", - "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - }, - "required": [ - "organization_name" - ] - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { "title": "Repository ruleset property targeting definition", "type": "object", - "description": "Parameters for a targeting a repository property", + "description": "Parameters for a targeting a organization property", "properties": { "name": { "type": "string", - "description": "The name of the repository property to target" + "description": "The name of the organization property to target" }, "property_values": { "type": "array", - "description": "The values to match for the repository property", + "description": "The values to match for the organization property", "items": { "type": "string" } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] } }, "required": [ @@ -46064,30 +49595,22 @@ }, "exclude": { "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", "items": { "title": "Repository ruleset property targeting definition", "type": "object", - "description": "Parameters for a targeting a repository property", + "description": "Parameters for a targeting a organization property", "properties": { "name": { "type": "string", - "description": "The name of the repository property to target" + "description": "The name of the organization property to target" }, "property_values": { "type": "array", - "description": "The values to match for the repository property", + "description": "The values to match for the organization property", "items": { "type": "string" } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] } }, "required": [ @@ -46100,62 +49623,7 @@ } }, "required": [ - "repository_property" - ] - }, - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - { - "type": "object", - "title": "organization_id_and_repository_name", - "description": "Conditions to target organizations by id and all repositories", - "allOf": [ - { - "title": "Repository ruleset conditions for organization IDs", - "type": "object", - "description": "Parameters for an organization ID condition", - "properties": { - "organization_id": { - "type": "object", - "properties": { - "organization_ids": { - "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "organization_id" + "organization_property" ] }, { @@ -46221,29 +49689,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_property", - "description": "Conditions to target organization by id and repositories by property", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -50147,36 +53660,262 @@ }, { "type": "object", - "title": "organization_name_and_repository_property", - "description": "Conditions to target organizations by name and repositories by property", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization names", + "title": "Repository ruleset conditions for organization IDs", "type": "object", - "description": "Parameters for an organization name condition", + "description": "Parameters for an organization ID condition", "properties": { - "organization_name": { + "organization_id": { "type": "object", "properties": { - "include": { - "type": "array", - "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", - "items": { - "type": "string" - } - }, - "exclude": { + "organization_ids": { "type": "array", - "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", "items": { - "type": "string" + "type": "integer" } } } } }, "required": [ - "organization_name" + "organization_id" ] }, { @@ -50292,29 +54031,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_name", - "description": "Conditions to target organizations by id and all repositories", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -50380,29 +54164,74 @@ }, { "type": "object", - "title": "organization_id_and_repository_property", - "description": "Conditions to target organization by id and repositories by property", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", "allOf": [ { - "title": "Repository ruleset conditions for organization IDs", + "title": "Repository ruleset conditions for organization properties", "type": "object", - "description": "Parameters for an organization ID condition", + "description": "Parameters for a organization property condition", "properties": { - "organization_id": { + "organization_property": { "type": "object", "properties": { - "organization_ids": { + "include": { "type": "array", - "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "description": "The organization properties and values to include. All of these properties must match for the condition to pass.", "items": { - "type": "integer" + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The organization properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a organization property", + "properties": { + "name": { + "type": "string", + "description": "The name of the organization property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the organization property", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "property_values" + ] } } } } }, "required": [ - "organization_id" + "organization_property" ] }, { @@ -54907,7 +58736,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -55891,6 +59720,19 @@ "schema": { "type": "string" } + }, + { + "name": "state", + "in": "query", + "description": "Set to `active` or `deleted` to only list cost centers in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ] + } } ], "responses": { @@ -57751,7 +61593,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -57934,7 +61776,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -57942,7 +61784,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -57950,7 +61792,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -59434,6 +63276,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -60748,6 +64600,772 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "examples": { + "default": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -60976,6 +65594,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -100929,10 +105557,377 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + }, + "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": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "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", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -101076,7 +106071,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -101084,7 +106079,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -101092,7 +106087,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -103312,6 +108307,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -103415,6 +108415,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -103555,6 +108559,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -103573,6 +108582,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -103653,6 +108667,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -103756,6 +108775,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -103811,6 +108834,587 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, + "examples": { + "default": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -104360,6 +109964,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -104463,6 +110072,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -104578,6 +110191,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -104647,6 +110265,261 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -104750,247 +110623,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "delete": { - "summary": "Delete a GitHub-hosted runner for an organization", - "description": "Deletes a GitHub-hosted runner for an organization.", - "operationId": "actions/delete-hosted-runner-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "example": true - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -110468,6 +116104,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -110571,6 +116212,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -119821,6 +125466,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -122588,7 +128337,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -122599,8 +128349,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -140169,29 +145930,6 @@ "type": "string" } }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -158973,6 +164711,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -159171,6 +164917,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -159948,6 +165703,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -160146,6 +165909,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -191028,16 +196800,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -198192,16 +203970,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -352339,16 +358123,6 @@ "default": "desc" } }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -352376,29 +358150,6 @@ "schema": { "type": "string" } - }, - { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "responses": { @@ -390802,6 +396553,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -391000,6 +396759,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -539565,7 +545333,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -618368,6 +624136,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -618566,6 +624342,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -678605,6 +684390,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -678803,6 +684596,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -685532,16 +691334,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -692669,16 +698477,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -716702,7 +722516,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -716833,7 +722647,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -716841,7 +722655,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -716849,7 +722663,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -891633,6 +897447,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -891831,6 +897653,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -894200,6 +900031,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -894398,6 +900237,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -896674,6 +902522,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -896872,6 +902728,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -899148,6 +905013,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -899346,6 +905219,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -901754,6 +907636,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -901952,6 +907842,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -904367,6 +910266,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -904565,6 +910472,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -908603,6 +914519,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -908801,6 +914725,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -1048250,6 +1054183,1600 @@ } } }, + "organization-custom-property-created": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "A new organization custom property was created.", + "operationId": "organization-custom-property/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "definition": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was deleted.", + "operationId": "organization-custom-property/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "definition": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property that was deleted." + } + }, + "required": [ + "property_name" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-updated": { + "post": { + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was updated.", + "operationId": "organization-custom-property/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "organization custom property updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "definition": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization_custom_property", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "organization-custom-property-values-updated": { + "post": { + "summary": "This event occurs when there is activity relating to custom property values for an organization.", + "description": "The custom property values of an organization were updated.", + "operationId": "organization-custom-property-values/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom property values updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "new_property_values": { + "type": "array", + "description": "The new custom property values.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + }, + "old_property_values": { + "type": "array", + "description": "The old custom property values.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "action", + "organization", + "enterprise", + "new_property_values", + "old_property_values" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "organization-custom-property-values", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "organization-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index b2f4ab095..461b32bd5 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -99,6 +99,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -446,7 +448,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &99 + - &104 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -455,7 +457,7 @@ paths: required: false schema: type: string - - &100 + - &105 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -464,7 +466,7 @@ paths: required: false schema: type: string - - &101 + - &106 name: direction description: The direction to sort the results by. in: query @@ -685,7 +687,7 @@ paths: required: - vector_string - score - cvss_severities: &115 + cvss_severities: &125 type: object nullable: true properties: @@ -725,7 +727,7 @@ paths: required: - vector_string - score - epss: &116 + epss: &126 type: object nullable: true readOnly: true @@ -863,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &412 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -996,7 +998,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &233 + schema: &251 title: Validation Error Simple description: Validation Error Simple type: object @@ -1029,7 +1031,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &737 + - &756 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1147,7 +1149,7 @@ paths: GitHub. type: object nullable: true - properties: &186 + properties: &203 id: description: Unique identifier of the GitHub app example: 37 @@ -1280,7 +1282,7 @@ paths: about itself. example: 5 type: integer - required: &187 + required: &204 - id - node_id - owner @@ -1585,7 +1587,7 @@ paths: schema: type: integer default: 30 - - &320 + - &338 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1601,7 +1603,7 @@ paths: application/json: schema: type: array - items: &321 + items: &339 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1681,7 +1683,7 @@ paths: - installation_id - repository_id examples: - default: &322 + default: &340 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1713,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &747 + schema: &766 title: Scim Error description: Scim Error type: object @@ -1740,7 +1742,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &232 + schema: &250 title: Validation Error description: Validation Error type: object @@ -1809,7 +1811,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &341 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1923,7 +1925,7 @@ paths: - request - response examples: - default: &324 + default: &342 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2124,7 +2126,7 @@ paths: parameters: - *17 - *19 - - &196 + - &213 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2369,6 +2371,14 @@ paths: token to update GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token to view and edit custom properties for an organization, + when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access @@ -2549,6 +2559,15 @@ paths: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access + token for organization custom properties management at + the enterprise level. + enum: + - read + - write + - admin enterprise_organization_installations: type: string description: The level of permission to grant the access @@ -2719,7 +2738,7 @@ paths: application/json: schema: *22 examples: - default: &79 + default: &84 value: id: 1 account: @@ -2869,11 +2888,11 @@ paths: - selected repositories: type: array - items: &69 + items: &74 title: Repository description: A repository on GitHub. type: object - properties: &390 + properties: &407 id: description: Unique identifier of the repository example: 42 @@ -2893,7 +2912,7 @@ paths: title: License Simple description: License Simple type: object - properties: &192 + properties: &209 key: type: string example: mit @@ -2915,7 +2934,7 @@ paths: html_url: type: string format: uri - required: &193 + required: &210 - key - name - url @@ -3311,7 +3330,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &391 + required: &408 - archive_url - assignees_url - blobs_url @@ -7468,7 +7487,7 @@ paths: description: Response content: application/json: - schema: &234 + schema: &252 type: object properties: total_active_caches_count: @@ -7483,7 +7502,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &235 + default: &253 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7569,13 +7588,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + example: latest required: - id - size_gb - display_name - source nullable: true - machine_size_details: &47 + machine_size_details: &52 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7658,6 +7682,10 @@ paths: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -7667,7 +7695,7 @@ paths: - public_ip_enabled - platform examples: - default: &236 + default: &254 value: total_count: 2 runners: @@ -7756,6 +7784,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -7775,6 +7808,11 @@ paths: `GET actions/hosted-runners/limits` type: boolean default: false + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -7797,7 +7835,7 @@ paths: application/json: schema: *44 examples: - default: &48 + default: &53 value: id: 5 name: My hosted ubuntu runner @@ -7824,6 +7862,309 @@ paths: githubCloudOnly: true category: actions subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an enterprise + description: |- + List custom images for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &45 + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` + parameter when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the + image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &47 + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get an enterprise custom image definition for GitHub Actions Hosted + Runners + description: |- + Get an enterprise custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *41 + - &46 + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *45 + examples: + default: &255 + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the enterprise + description: |- + Delete a custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + parameters: + - *41 + - *46 + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an enterprise + description: |- + List image versions of a custom image for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + parameters: + - *46 + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: &48 + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image + version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *47 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of an enterprise custom image for GitHub Actions + Hosted Runners + description: |- + Get an image version of an enterprise custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + parameters: + - *41 + - *46 + - &49 + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: &256 + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the enterprise + description: |- + Delete an image version of custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + parameters: + - *41 + - *46 + - *49 + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an enterprise @@ -7852,7 +8193,7 @@ paths: type: integer images: type: array - items: &45 + items: &50 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -7888,7 +8229,7 @@ paths: - display_name - source examples: - default: &46 + default: &51 value: id: ubuntu-20.04 platform: linux-x64 @@ -7928,9 +8269,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -7953,7 +8294,7 @@ paths: description: Response content: application/json: - schema: &237 + schema: &257 type: object properties: public_ips: @@ -7978,7 +8319,7 @@ paths: required: - public_ips examples: - default: &238 + default: &258 value: public_ips: current_usage: 17 @@ -8016,9 +8357,9 @@ paths: type: integer machine_specs: type: array - items: *47 + items: *52 examples: - default: &239 + default: &259 value: id: 4-core cpu_cores: 4 @@ -8086,7 +8427,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - &49 + - &54 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8100,7 +8441,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 headers: Link: *43 x-github: @@ -8121,7 +8462,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *49 + - *54 requestBody: required: true content: @@ -8147,6 +8488,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -8161,7 +8507,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8178,7 +8524,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *49 + - *54 responses: '202': description: Response @@ -8186,7 +8532,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8254,7 +8600,7 @@ paths: schema: type: object properties: - enabled_organizations: &50 + enabled_organizations: &55 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8267,7 +8613,7 @@ paths: description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. - allowed_actions: &51 + allowed_actions: &56 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8275,12 +8621,12 @@ paths: - all - local_only - selected - selected_actions_url: &242 + selected_actions_url: &262 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &52 + sha_pinning_required: &57 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8322,9 +8668,9 @@ paths: schema: type: object properties: - enabled_organizations: *50 - allowed_actions: *51 - sha_pinning_required: *52 + enabled_organizations: *55 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled_organizations examples: @@ -8355,7 +8701,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &244 + schema: &264 type: object properties: days: @@ -8373,7 +8719,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &748 + '401': &767 description: Authorization failure '404': *6 x-github: @@ -8401,7 +8747,7 @@ paths: required: true content: application/json: - schema: &245 + schema: &265 type: object properties: days: @@ -8436,7 +8782,7 @@ paths: description: Response content: application/json: - schema: &53 + schema: &58 type: object properties: approval_policy: @@ -8450,7 +8796,7 @@ paths: required: - approval_policy examples: - default: &246 + default: &266 value: approval_policy: first_time_contributors '404': *6 @@ -8479,7 +8825,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -8508,7 +8854,7 @@ paths: description: Response content: application/json: - schema: &247 + schema: &267 type: object required: - run_workflows_from_fork_pull_requests @@ -8534,7 +8880,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &54 + default: &59 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8562,7 +8908,7 @@ paths: required: true content: application/json: - schema: &248 + schema: &268 type: object required: - run_workflows_from_fork_pull_requests @@ -8585,7 +8931,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -8625,11 +8971,11 @@ paths: type: number organizations: type: array - items: &64 + items: &69 title: Organization Simple description: A GitHub organization. type: object - properties: &111 + properties: &116 login: type: string example: github @@ -8670,7 +9016,7 @@ paths: type: string example: A great organization nullable: true - required: &112 + required: &117 - login - url - id @@ -8687,7 +9033,7 @@ paths: - total_count - organizations examples: - default: &65 + default: &70 value: total_count: 1 organizations: @@ -8766,7 +9112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &55 + - &60 name: org_id description: The unique identifier of the organization. in: path @@ -8795,7 +9141,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *55 + - *60 responses: '204': description: Response @@ -8824,7 +9170,7 @@ paths: description: Response content: application/json: - schema: &56 + schema: &61 type: object properties: github_owned_allowed: @@ -8845,7 +9191,7 @@ paths: items: type: string examples: - default: &57 + default: &62 value: github_owned_allowed: true verified_allowed: false @@ -8878,9 +9224,9 @@ paths: required: true content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8985,17 +9331,17 @@ paths: description: Success response content: application/json: - schema: &251 + schema: &271 type: object properties: - default_workflow_permissions: &58 + default_workflow_permissions: &63 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &59 + can_approve_pull_request_reviews: &64 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9003,7 +9349,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &60 + default: &65 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9033,13 +9379,13 @@ paths: required: true content: application/json: - schema: &252 + schema: &272 type: object properties: - default_workflow_permissions: *58 - can_approve_pull_request_reviews: *59 + default_workflow_permissions: *63 + can_approve_pull_request_reviews: *64 examples: - default: *60 + default: *65 responses: '204': description: Success response @@ -9084,7 +9430,7 @@ paths: type: number runner_groups: type: array - items: &61 + items: &66 type: object properties: id: @@ -9263,9 +9609,9 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: - default: &62 + default: &67 value: id: 2 name: octo-runner-group @@ -9300,7 +9646,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &63 + - &68 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9312,9 +9658,9 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: - default: *62 + default: *67 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9334,7 +9680,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: false content: @@ -9386,7 +9732,7 @@ paths: description: Response content: application/json: - schema: *61 + schema: *66 examples: default: value: @@ -9422,7 +9768,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *63 + - *68 responses: '204': description: Response @@ -9446,7 +9792,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 + - *68 - *17 - *19 responses: @@ -9461,12 +9807,12 @@ paths: type: number organizations: type: array - items: *64 + items: *69 required: - total_count - organizations examples: - default: *65 + default: *70 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9486,7 +9832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: true content: @@ -9532,8 +9878,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 - - *55 + - *68 + - *60 responses: '204': description: Response @@ -9556,8 +9902,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *63 - - *55 + - *68 + - *60 responses: '204': description: Response @@ -9581,7 +9927,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *63 + - *68 - *17 - *19 responses: @@ -9596,7 +9942,7 @@ paths: type: number runners: type: array - items: &67 + items: &72 title: Self hosted runners description: A self hosted runner type: object @@ -9625,7 +9971,7 @@ paths: type: boolean labels: type: array - items: &71 + items: &76 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -9658,7 +10004,7 @@ paths: - total_count - runners examples: - default: &68 + default: &73 value: total_count: 2 runners: @@ -9718,7 +10064,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *63 + - *68 requestBody: required: true content: @@ -9763,8 +10109,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *63 - - &66 + - *68 + - &71 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -9793,8 +10139,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *63 - - *66 + - *68 + - *71 responses: '204': description: Response @@ -9837,9 +10183,9 @@ paths: type: number runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -9869,7 +10215,7 @@ paths: application/json: schema: type: array - items: &256 + items: &276 title: Runner Application description: Runner Application type: object @@ -9894,7 +10240,7 @@ paths: - download_url - filename examples: - default: &257 + default: &277 value: - os: osx architecture: x64 @@ -9978,7 +10324,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &258 + '201': &278 description: Response content: application/json: @@ -9988,7 +10334,7 @@ paths: - runner - encoded_jit_config properties: - runner: *67 + runner: *72 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10017,7 +10363,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &109 + '409': &114 description: Conflict content: application/json: @@ -10055,7 +10401,7 @@ paths: description: Response content: application/json: - schema: &70 + schema: &75 title: Authentication Token description: Authentication Token type: object @@ -10077,7 +10423,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *69 + items: *74 single_file: type: string example: config.yaml @@ -10093,7 +10439,7 @@ paths: - token - expires_at examples: - default: &259 + default: &279 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10131,9 +10477,9 @@ paths: description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: &260 + default: &280 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10157,15 +10503,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: &261 + default: &281 value: id: 23 name: MBP @@ -10205,7 +10551,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *66 + - *71 responses: '204': description: Response @@ -10230,9 +10576,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: - '200': &72 + '200': &77 description: Response content: application/json: @@ -10246,7 +10592,7 @@ paths: type: integer labels: type: array - items: *71 + items: *76 examples: default: value: @@ -10284,7 +10630,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 requestBody: required: true content: @@ -10308,7 +10654,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10331,7 +10677,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 requestBody: required: true content: @@ -10356,7 +10702,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10379,9 +10725,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 + - *71 responses: - '200': &262 + '200': &282 description: Response content: application/json: @@ -10395,7 +10741,7 @@ paths: type: integer labels: type: array - items: *71 + items: *76 examples: default: value: @@ -10436,8 +10782,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *66 - - &263 + - *71 + - &283 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10445,7 +10791,7 @@ paths: schema: type: string responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -10470,20 +10816,20 @@ paths: description: Response content: application/json: - schema: &77 + schema: &82 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &73 + announcement: &78 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &74 + expires_at: &79 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10493,7 +10839,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &75 + user_dismissible: &80 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10504,7 +10850,7 @@ paths: - expires_at - user_dismissible examples: - default: &76 + default: &81 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10528,18 +10874,18 @@ paths: required: true content: application/json: - schema: &270 + schema: &290 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *73 - expires_at: *74 - user_dismissible: *75 + announcement: *78 + expires_at: *79 + user_dismissible: *80 required: - announcement examples: - default: *76 + default: *81 parameters: - *41 responses: @@ -10547,9 +10893,9 @@ paths: description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -10645,7 +10991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &78 + - &83 name: org description: The organization name. The name is not case sensitive. in: path @@ -10662,7 +11008,7 @@ paths: application/json: schema: type: array - items: &80 + items: &85 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -10713,7 +11059,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 - *17 - *19 responses: @@ -10808,7 +11154,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 responses: '200': description: A GitHub App installation that was installed previously. @@ -10816,14 +11162,14 @@ paths: application/json: schema: *22 examples: - default: *79 + default: *84 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *79 + default: *84 requestBody: required: true content: @@ -10891,7 +11237,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *78 + - *83 - *23 responses: '204': @@ -10919,7 +11265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *78 + - *83 - *23 - *17 - *19 @@ -10931,7 +11277,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -10960,7 +11306,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *78 + - *83 - *23 requestBody: required: true @@ -11000,7 +11346,7 @@ paths: application/json: schema: *22 examples: - default: *79 + default: *84 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11021,7 +11367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *78 + - *83 - *23 responses: '200': @@ -11031,7 +11377,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -11082,7 +11428,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *78 + - *83 - *23 responses: '200': @@ -11092,7 +11438,7 @@ paths: application/json: schema: type: array - items: *80 + items: *85 examples: default: value: @@ -11169,7 +11515,7 @@ paths: required: false schema: type: string - - &271 + - &291 name: include description: |- The event types to include: @@ -11187,7 +11533,7 @@ paths: - web - git - all - - &272 + - &292 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -11195,7 +11541,7 @@ paths: required: false schema: type: string - - &273 + - &293 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -11203,7 +11549,7 @@ paths: required: false schema: type: string - - &274 + - &294 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11225,7 +11571,7 @@ paths: application/json: schema: type: array - items: &275 + items: &295 type: object properties: "@timestamp": @@ -11347,7 +11693,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &276 + default: &296 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11526,7 +11872,7 @@ paths: vendor_specific: type: object oneOf: - - &84 + - &89 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11545,7 +11891,7 @@ paths: - key_id - encrypted_sas_url - container - - &85 + - &90 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11564,7 +11910,7 @@ paths: - name - encrypted_connstring - key_id - - &86 + - &91 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11592,7 +11938,7 @@ paths: - bucket - key_id - region - - &87 + - &92 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11626,7 +11972,7 @@ paths: - encrypted_secret_key - key_id - region - - &88 + - &93 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -11654,7 +12000,7 @@ paths: - key_id - port - ssl_verify - - &89 + - &94 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -11686,7 +12032,7 @@ paths: - key_id - port - ssl_verify - - &90 + - &95 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -11704,7 +12050,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &91 + - &96 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -11735,7 +12081,7 @@ paths: - stream_type - vendor_specific examples: - default: &92 + default: &97 value: enabled: false stream_type: Azure Event Hubs @@ -11749,7 +12095,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &81 + schema: &86 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -11780,7 +12126,7 @@ paths: - created_at - updated_at examples: - default: &82 + default: &87 value: id: 1 stream_type: Splunk @@ -11809,7 +12155,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &83 + - &88 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -11821,9 +12167,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *81 + schema: *86 examples: - default: *82 + default: *87 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11843,7 +12189,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *83 + - *88 requestBody: required: true content: @@ -11869,28 +12215,28 @@ paths: vendor_specific: type: object oneOf: - - *84 - - *85 - - *86 - - *87 - - *88 - *89 - *90 - *91 + - *92 + - *93 + - *94 + - *95 + - *96 required: - enabled - stream_type - vendor_specific examples: - default: *92 + default: *97 responses: '200': description: Successful update content: application/json: - schema: *81 + schema: *86 examples: - default: *82 + default: *87 '422': description: Validation error content: @@ -11921,7 +12267,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *83 + - *88 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -11948,13 +12294,13 @@ paths: subcategory: bypass-requests parameters: - *41 - - &93 + - &98 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &94 + - &99 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -11962,7 +12308,7 @@ paths: required: false schema: type: string - - &95 + - &100 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -11970,7 +12316,7 @@ paths: required: false schema: type: string - - &96 + - &101 name: time_period description: |- The time period to filter by. @@ -11986,7 +12332,7 @@ paths: - week - month default: day - - &97 + - &102 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12013,7 +12359,7 @@ paths: application/json: schema: type: array - items: &277 + items: &297 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12130,7 +12476,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &98 + items: &103 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12174,7 +12520,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &278 + default: &298 value: - id: 21 number: 42 @@ -12265,11 +12611,11 @@ paths: subcategory: delegated-bypass parameters: - *41 - - *93 - - *94 - - *95 - - *96 - - *97 + - *98 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -12279,7 +12625,7 @@ paths: application/json: schema: type: array - items: &280 + items: &300 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12393,7 +12739,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *98 + items: *103 url: type: string format: uri @@ -12404,7 +12750,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &281 + default: &301 value: - id: 21 number: 42 @@ -12489,17 +12835,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &286 + - &306 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &102 + schema: &107 type: string description: The name of the tool used to generate the code scanning analysis. - - &287 + - &307 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -12507,22 +12853,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &103 + schema: &108 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *99 - - *100 + - *104 + - *105 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &288 + schema: &308 type: string description: State of a code scanning alert. enum: @@ -12547,42 +12893,42 @@ paths: application/json: schema: type: array - items: &289 + items: &309 type: object properties: - number: &113 + number: &123 type: integer description: The security alert number. readOnly: true - created_at: &120 + created_at: &130 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &121 + updated_at: &131 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - url: &118 + url: &128 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &119 + html_url: &129 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &526 + instances_url: &543 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &104 + state: &109 type: string description: State of a code scanning alert. nullable: true @@ -12590,7 +12936,7 @@ paths: - open - dismissed - fixed - fixed_at: &123 + fixed_at: &133 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12604,14 +12950,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &122 + dismissed_at: &132 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &527 + dismissed_reason: &544 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12620,13 +12966,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &528 + dismissed_comment: &545 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &529 + rule: &546 type: object properties: id: @@ -12679,25 +13025,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &530 + tool: &547 type: object properties: - name: *102 + name: *107 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *103 - most_recent_instance: &531 + guid: *108 + most_recent_instance: &548 type: object properties: - ref: &524 + ref: &541 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &541 + analysis_key: &558 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -12708,13 +13054,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &542 + category: &559 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *104 + state: *109 commit_sha: type: string message: @@ -12753,11 +13099,11 @@ paths: - generated - test - library - repository: &110 + repository: &115 title: Simple Repository description: A GitHub repository. type: object - properties: &220 + properties: &238 id: type: integer format: int64 @@ -12984,7 +13330,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &221 + required: &239 - archive_url - assignees_url - blobs_url @@ -13056,7 +13402,7 @@ paths: - most_recent_instance - repository examples: - default: &290 + default: &310 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13287,7 +13633,7 @@ paths: headers: Link: *43 '404': *6 - '503': &167 + '503': &183 description: Service unavailable content: application/json: @@ -13331,8 +13677,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -13340,7 +13686,7 @@ paths: application/json: schema: type: array - items: &105 + items: &110 type: object description: A code security configuration properties: @@ -13709,7 +14055,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &291 + code_scanning_options: &311 type: object description: Security Configuration feature options for code scanning nullable: true @@ -13726,7 +14072,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &108 + code_scanning_default_setup_options: &113 type: object description: Feature options for code scanning default setup nullable: true @@ -13843,9 +14189,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *105 + schema: *110 examples: - default: &106 + default: &111 value: id: 1325 target_type: enterprise @@ -13903,7 +14249,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &313 type: array description: A list of default code security configurations items: @@ -13917,9 +14263,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *105 + configuration: *110 examples: - default: &294 + default: &314 value: - default_for_new_repos: public configuration: @@ -14008,7 +14354,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &107 + - &112 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14020,9 +14366,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *106 + default: *111 '304': *37 '403': *29 '404': *6 @@ -14047,7 +14393,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14126,7 +14472,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14214,13 +14560,13 @@ paths: description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *106 + default: *111 '304': *37 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14244,14 +14590,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *107 + - *112 responses: - '204': &133 + '204': &143 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14276,7 +14622,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14303,7 +14649,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14328,7 +14674,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *107 + - *112 requestBody: required: true content: @@ -14368,12 +14714,12 @@ paths: - none - private_and_internal - public - configuration: *105 + configuration: *110 examples: default: value: default_for_new_repos: all - configuration: &292 + configuration: &312 value: id: 1325 target_type: organization @@ -14430,7 +14776,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *107 + - *112 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -14439,8 +14785,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14458,7 +14804,7 @@ paths: application/json: schema: type: array - items: &295 + items: &315 type: object description: Repositories associated with a code security configuration and attachment status @@ -14476,13 +14822,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *110 + repository: *115 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &296 + repository: &316 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -14947,7 +15293,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &124 + items: &134 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -14964,14 +15310,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *111 - required: *112 + properties: *116 + required: *117 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &282 + - &302 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15046,7 +15392,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &355 + properties: &373 id: description: Unique identifier of the team type: integer @@ -15118,7 +15464,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &356 + required: &374 - id - node_id - url @@ -15144,7 +15490,7 @@ paths: - slug - parent - type - - &178 + - &194 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15254,7 +15600,7 @@ paths: - created_at additionalProperties: false examples: - default: &125 + default: &135 value: total_seats: 2 seats: @@ -15706,7 +16052,7 @@ paths: application/json: schema: type: array - items: &175 + items: &191 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16013,7 +16359,7 @@ paths: - date additionalProperties: true examples: - default: &176 + default: &192 value: - date: '2024-06-24' total_active_users: 24 @@ -16115,7 +16461,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &177 + '422': &193 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16126,6 +16472,212 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - *41 + - &118 + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + example: '2025-10-13' + responses: + '200': + description: Response + content: + application/json: + schema: &119 + type: object + title: Copilot Metrics 1 Day Report + description: Links to download the Copilot usage metrics report for + an enterprise for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the Copilot usage metrics report + for the enterprise for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + examples: + default: &120 + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": + get: + summary: Get Copilot enterprise usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &121 + type: object + title: Copilot Metrics 28 Day Report + description: Links to download the latest Copilot usage metrics report + for an enterprise. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the latest Copilot usage metrics + report for the enterprise. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` + format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` + format. + required: + - download_links + - report_start_day + - report_end_day + examples: + default: &122 + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - *41 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *40 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -16145,7 +16697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &303 + - &323 name: state in: query description: |- @@ -16154,7 +16706,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &304 + - &324 name: severity in: query description: |- @@ -16163,7 +16715,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &305 + - &325 name: ecosystem in: query description: |- @@ -16172,14 +16724,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &306 + - &326 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &307 + - &327 name: epss_percentage in: query description: |- @@ -16191,7 +16743,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &581 + - &598 name: has in: query description: |- @@ -16205,7 +16757,7 @@ paths: type: string enum: - patch - - &308 + - &328 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16215,7 +16767,7 @@ paths: enum: - development - runtime - - &309 + - &329 name: sort in: query description: |- @@ -16230,34 +16782,9 @@ paths: - updated - epss_percentage default: created - - *101 - - *99 - - *100 - - &310 - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - &311 - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 + - *106 + - *104 + - *105 - *17 responses: '200': @@ -16266,11 +16793,11 @@ paths: application/json: schema: type: array - items: &312 + items: &330 type: object description: A Dependabot alert. properties: - number: *113 + number: *123 state: type: string description: The state of the Dependabot alert. @@ -16285,7 +16812,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &114 + package: &124 type: object description: Details for the vulnerable package. readOnly: true @@ -16329,7 +16856,7 @@ paths: - unknown - direct - transitive - security_advisory: &582 + security_advisory: &599 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16359,13 +16886,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &117 + items: &127 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *114 + package: *124 severity: type: string description: The severity of the vulnerability. @@ -16431,8 +16958,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *115 - epss: *116 + cvss_severities: *125 + epss: *126 cwes: type: array description: Details for the advisory pertaining to Common @@ -16531,12 +17058,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *117 - url: *118 - html_url: *119 - created_at: *120 - updated_at: *121 - dismissed_at: *122 + security_vulnerability: *127 + url: *128 + html_url: *129 + created_at: *130 + updated_at: *131 + dismissed_at: *132 dismissed_by: title: Simple User description: A GitHub user. @@ -16560,15 +17087,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *123 - auto_dismissed_at: &583 + fixed_at: *133 + auto_dismissed_at: &600 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *110 + repository: *115 required: - number - state @@ -16587,7 +17114,7 @@ paths: - repository additionalProperties: false examples: - default: &313 + default: &331 value: - number: 2 state: dismissed @@ -17004,7 +17531,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - &182 + - &198 name: username description: The handle for the GitHub user account. in: path @@ -17026,9 +17553,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *124 + items: *134 examples: - default: *125 + default: *135 '500': *40 '401': *25 '403': *29 @@ -17071,7 +17598,7 @@ paths: type: integer network_configurations: type: array - items: &126 + items: &136 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -17111,7 +17638,7 @@ paths: - name - created_on examples: - default: &423 + default: &440 value: total_count: 2 network_configurations: @@ -17189,9 +17716,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: &127 + default: &137 value: id: 123456789ABCDEF name: My network configuration @@ -17218,7 +17745,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &128 + - &138 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -17230,9 +17757,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 headers: Link: *43 x-github: @@ -17252,7 +17779,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *128 + - *138 requestBody: required: true content: @@ -17291,9 +17818,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -17311,7 +17838,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *128 + - *138 responses: '204': description: Response @@ -17334,7 +17861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &424 + - &441 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -17346,7 +17873,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &442 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -17380,7 +17907,7 @@ paths: - subnet_id - region examples: - default: &426 + default: &443 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -17394,6 +17921,516 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations + "/enterprises/{enterprise}/org-properties/schema": + get: + summary: Get organization custom properties schema for an enterprise + description: |- + Gets all organization custom property definitions that are defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &139 + title: Custom Property for Organization + description: Custom property defined for an organization + allOf: + - type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or + delete info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + - type: object + properties: + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + examples: + default: &140 + value: + properties: + - property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + - property_name: service + url: https://api.github.com/enterprises/github/org-properties/schema/service + source_type: enterprise + value_type: string + - property_name: team + url: https://api.github.com/enterprises/github/org-properties/schema/team + source_type: enterprise + value_type: string + description: Team owning the organization + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update organization custom property definitions on an enterprise + description: |- + Creates new or updates existing organization custom properties defined on an enterprise in a batch. + + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of organization custom properties to create + or update. + items: *139 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: *140 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *139 + examples: + default: *140 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": + get: + summary: Get an organization custom property definition from an enterprise + description: |- + Gets an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + parameters: + - *41 + - &141 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *139 + examples: + default: &142 + value: + property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + put: + summary: Create or update an organization custom property definition on an enterprise + description: |- + Creates a new or updates an existing organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + parameters: + - *41 + - *141 + requestBody: + required: true + content: + application/json: + schema: + title: Organization Custom Property Payload + description: Payload for creating or updating an organization custom + property definition on an enterprise. + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property. + description: + type: string + nullable: true + description: Short description of the property. + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property. + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: *139 + examples: + default: *142 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + delete: + summary: Remove an organization custom property definition from an enterprise + description: |- + Removes an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + parameters: + - *41 + - *141 + responses: + '204': *143 + '403': *29 + '404': *6 + '422': *7 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/values": + get: + summary: List custom property values for organizations in an enterprise + description: |- + Lists enterprise organizations with all of their custom property values. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + parameters: + - *41 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + title: Enterprise Organization Custom Property Values + description: List of custom property values for an organization + type: object + properties: + organization_id: + type: integer + example: 1296269 + organization_login: + type: string + example: Hello-World + properties: + type: array + items: &144 + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + description: List of custom property names and associated values + required: + - organization_id + - organization_login + - properties + examples: + default: + value: + - organization_id: 1296269 + organization_login: Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + headers: + Link: *43 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for organizations in an enterprise + description: |- + Create or update custom property values for organizations in an enterprise. + + To remove a custom property value from an organization, set the property value to `null`. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "edit enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + organization_logins: + type: array + description: The names of organizations that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the organizations. + items: *144 + required: + - organization_logins + - properties + examples: + default: + value: + organization_logins: + - acme + - github + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/properties/schema": get: summary: Get custom properties for an enterprise @@ -17415,7 +18452,7 @@ paths: application/json: schema: type: array - items: &129 + items: &145 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -17481,7 +18518,7 @@ paths: - property_name - value_type examples: - default: &130 + default: &146 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -17538,7 +18575,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *129 + items: *145 minItems: 1 maxItems: 100 required: @@ -17568,9 +18605,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -17593,22 +18630,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *78 - - &131 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *83 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: &132 + default: &147 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -17641,15 +18672,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -17671,12 +18702,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 requestBody: required: true content: application/json: - schema: &388 + schema: &406 title: Custom Property Set Payload description: Custom property set payload type: object @@ -17740,9 +18771,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -17764,9 +18795,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *131 + - *141 responses: - '204': *133 + '204': *143 '403': *29 '404': *6 x-github: @@ -17806,7 +18837,7 @@ paths: - push - repository default: branch - enforcement: &140 + enforcement: &156 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -17819,7 +18850,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &141 + items: &157 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -17860,7 +18891,7 @@ paths: - pull_request - exempt default: always - conditions: &164 + conditions: &180 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -17874,7 +18905,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &134 + - &148 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -17900,7 +18931,7 @@ paths: type: string required: - organization_name - - &137 + - &151 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -17929,7 +18960,7 @@ paths: is prevented. required: - repository_name - - &136 + - &150 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -17957,8 +18988,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *134 - - &139 + - *148 + - &153 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -17971,7 +19002,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &135 + items: &149 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -18002,16 +19033,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *135 + items: *149 required: - repository_property - - *136 + - *150 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &138 + - &152 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -18028,25 +19059,80 @@ paths: type: integer required: - organization_id - - *137 - - *136 + - *151 + - *150 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *138 - - *139 - - *136 + - *152 + - *153 + - *150 + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and + all repositories + allOf: + - &155 + title: Repository ruleset conditions for organization properties + type: object + description: Parameters for a organization property condition + properties: + organization_property: + type: object + properties: + include: + type: array + description: The organization properties and values + to include. All of these properties must match for + the condition to pass. + items: &154 + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a organization + property + properties: + name: + type: string + description: The name of the organization property + to target + property_values: + type: array + description: The values to match for the organization + property + items: + type: string + required: + - name + - property_values + exclude: + type: array + description: The organization properties and values + to exclude. The condition will not pass if any of + these properties match. + items: *154 + required: + - organization_property + - *151 + - *150 + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and + repositories by property + allOf: + - *155 + - *153 + - *150 rules: type: array description: An array of rules within the ruleset. - items: &165 + items: &181 title: Repository Rule type: object description: A repository rule. oneOf: - - &142 + - &158 title: creation description: Only allow users with bypass permission to create matching refs. @@ -18058,7 +19144,7 @@ paths: type: string enum: - creation - - &143 + - &159 title: update description: Only allow users with bypass permission to update matching refs. @@ -18079,7 +19165,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &144 + - &160 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -18091,7 +19177,7 @@ paths: type: string enum: - deletion - - &145 + - &161 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -18103,7 +19189,7 @@ paths: type: string enum: - required_linear_history - - &146 + - &162 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -18127,7 +19213,7 @@ paths: type: string required: - required_deployment_environments - - &147 + - &163 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -18139,7 +19225,7 @@ paths: type: string enum: - required_signatures - - &148 + - &164 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -18199,7 +19285,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &149 + - &165 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -18246,7 +19332,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &150 + - &166 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -18258,7 +19344,7 @@ paths: type: string enum: - non_fast_forward - - &151 + - &167 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -18294,7 +19380,7 @@ paths: required: - operator - pattern - - &152 + - &168 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -18330,7 +19416,7 @@ paths: required: - operator - pattern - - &153 + - &169 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -18366,7 +19452,7 @@ paths: required: - operator - pattern - - &154 + - &170 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -18402,7 +19488,7 @@ paths: required: - operator - pattern - - &155 + - &171 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -18438,7 +19524,7 @@ paths: required: - operator - pattern - - &156 + - &172 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -18462,7 +19548,7 @@ paths: type: string required: - restricted_file_paths - - &157 + - &173 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -18486,7 +19572,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &158 + - &174 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -18509,7 +19595,7 @@ paths: type: string required: - restricted_file_extensions - - &159 + - &175 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -18533,7 +19619,7 @@ paths: maximum: 100 required: - max_file_size - - &160 + - &176 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -18582,7 +19668,7 @@ paths: - repository_id required: - workflows - - &161 + - &177 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -18668,7 +19754,7 @@ paths: description: Response content: application/json: - schema: &162 + schema: &178 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -18703,11 +19789,11 @@ paths: source: type: string description: The name of the source - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 + items: *157 current_user_can_bypass: type: string description: |- @@ -18739,8 +19825,8 @@ paths: conditions: nullable: true anyOf: - - *136 - - &395 + - *150 + - &412 title: Organization ruleset conditions type: object description: |- @@ -18754,14 +19840,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *136 - - *137 + - *150 + - *151 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *136 + - *150 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -18783,20 +19869,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *136 - - *139 + - *150 + - *153 rules: type: array - items: &703 + items: &722 title: Repository Rule type: object description: A repository rule. oneOf: - - *142 - - *143 - - *144 - - *145 - - &700 + - *158 + - *159 + - *160 + - *161 + - &719 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -18874,23 +19960,23 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - - *158 - - *159 - - *160 - - *161 - - &701 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - *174 + - *175 + - *176 + - *177 + - &720 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -18920,7 +20006,7 @@ paths: type: string format: date-time examples: - default: &163 + default: &179 value: id: 21 name: super cool ruleset @@ -18979,9 +20065,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *163 + default: *179 '404': *6 '500': *40 x-github: @@ -19025,16 +20111,16 @@ paths: - tag - push - repository - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *164 + items: *157 + conditions: *180 rules: description: An array of rules within the ruleset. type: array - items: *165 + items: *181 examples: default: value: @@ -19058,9 +20144,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *163 + default: *179 '404': *6 '500': *40 x-github: @@ -19122,7 +20208,7 @@ paths: application/json: schema: type: array - items: &166 + items: &182 title: Ruleset version type: object description: The historical version of a ruleset @@ -19146,7 +20232,7 @@ paths: type: string format: date-time examples: - default: &398 + default: &415 value: - version_id: 3 actor: @@ -19199,9 +20285,9 @@ paths: description: Response content: application/json: - schema: &399 + schema: &416 allOf: - - *166 + - *182 - type: object required: - state @@ -19254,7 +20340,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &400 + - &417 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -19265,7 +20351,7 @@ paths: enum: - open - resolved - - &401 + - &418 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -19275,7 +20361,7 @@ paths: required: false schema: type: string - - &402 + - &419 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -19284,7 +20370,7 @@ paths: required: false schema: type: string - - &403 + - &420 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -19296,11 +20382,11 @@ paths: - created - updated default: created - - *101 + - *106 - *17 - - *99 - - *100 - - &404 + - *104 + - *105 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -19309,7 +20395,7 @@ paths: required: false schema: type: string - - &405 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -19318,7 +20404,7 @@ paths: schema: type: boolean default: false - - &406 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -19327,7 +20413,7 @@ paths: schema: type: boolean default: false - - &407 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -19343,11 +20429,11 @@ paths: application/json: schema: type: array - items: &408 + items: &425 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -19355,21 +20441,21 @@ paths: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &715 + state: &734 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &716 + resolution: &735 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -19403,7 +20489,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *110 + repository: *115 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -19476,8 +20562,8 @@ paths: pull request. ' - oneOf: &717 - - &719 + oneOf: &736 + - &738 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -19529,7 +20615,7 @@ paths: - blob_url - commit_sha - commit_url - - &720 + - &739 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -19584,7 +20670,7 @@ paths: - page_url - commit_sha - commit_url - - &721 + - &740 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -19598,7 +20684,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &722 + - &741 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -19612,7 +20698,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &723 + - &742 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -19626,7 +20712,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &724 + - &743 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -19640,7 +20726,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &725 + - &744 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -19654,7 +20740,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &726 + - &745 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -19668,7 +20754,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &727 + - &746 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -19682,7 +20768,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &728 + - &747 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -19696,7 +20782,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &729 + - &748 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -19710,7 +20796,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &730 + - &749 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -19724,7 +20810,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &731 + - &750 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -19751,7 +20837,7 @@ paths: required: *21 nullable: true examples: - default: &409 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -19929,9 +21015,9 @@ paths: headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -19960,13 +21046,13 @@ paths: description: Response content: application/json: - schema: &410 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: - pattern_config_version: &169 + pattern_config_version: &185 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -19975,7 +21061,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &168 + items: &184 type: object properties: token_type: @@ -20041,9 +21127,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *168 + items: *184 examples: - default: &411 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -20098,7 +21184,7 @@ paths: schema: type: object properties: - pattern_config_version: *169 + pattern_config_version: *185 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -20124,7 +21210,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *169 + custom_pattern_version: *185 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -20160,7 +21246,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: @@ -20187,7 +21273,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &431 type: object properties: total_minutes_used: @@ -20257,7 +21343,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &415 + default: &432 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -20288,7 +21374,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &416 + - &433 name: advanced_security_product in: query description: | @@ -20308,7 +21394,7 @@ paths: description: Success content: application/json: - schema: &417 + schema: &434 type: object properties: total_advanced_security_committers: @@ -20363,7 +21449,7 @@ paths: required: - repositories examples: - default: &418 + default: &435 value: total_advanced_security_committers: 2 total_count: 2 @@ -20402,6 +21488,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - *41 + - name: state + in: query + description: Set to `active` or `deleted` to only list cost centers in a specific + state. + required: false + schema: + type: string + enum: + - active + - deleted responses: '200': description: Response when getting cost centers @@ -20473,7 +21569,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20602,7 +21698,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &172 + - &188 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -20614,7 +21710,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &170 + schema: &186 type: object properties: id: @@ -20653,7 +21749,7 @@ paths: - name - resources examples: - default: &171 + default: &187 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -20667,7 +21763,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20717,15 +21813,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *170 + schema: *186 examples: - default: *171 + default: *187 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20743,7 +21839,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *172 + - *188 responses: '200': description: Response when deleting a cost center @@ -20782,7 +21878,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20803,7 +21899,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *172 + - *188 requestBody: required: true content: @@ -20873,9 +21969,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *29 - '409': *109 + '409': *114 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20895,7 +21991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *172 + - *188 requestBody: required: true content: @@ -20942,7 +22038,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -20973,7 +22069,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &436 type: object properties: total_gigabytes_bandwidth_used: @@ -20991,7 +22087,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &420 + default: &437 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -21004,8 +22100,10 @@ paths: "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise - description: Gets a report of premium request usage for an enterprise. To use - this endpoint, you must be an administrator or billing manager of the enterprise. + description: |- + Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe @@ -21014,7 +22112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &173 + - &189 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -21023,7 +22121,7 @@ paths: required: false schema: type: integer - - &222 + - &240 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current @@ -21032,7 +22130,7 @@ paths: required: false schema: type: integer - - &174 + - &190 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -21048,21 +22146,21 @@ paths: required: false schema: type: string - - &223 + - &241 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &224 + - &242 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &225 + - &243 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -21146,19 +22244,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -21201,7 +22299,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21232,7 +22330,7 @@ paths: description: Response content: application/json: - schema: &421 + schema: &438 type: object properties: days_left_in_billing_cycle: @@ -21250,7 +22348,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &422 + default: &439 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -21275,8 +22373,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *173 - - &226 + - *189 + - &244 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -21285,8 +22383,8 @@ paths: required: false schema: type: integer - - *174 - - &227 + - *190 + - &245 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -21307,7 +22405,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &228 + schema: &246 type: object properties: usageItems: @@ -21360,7 +22458,7 @@ paths: - netAmount - organizationName examples: - default: &229 + default: &247 value: usageItems: - date: '2023-08-01' @@ -21377,7 +22475,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21448,13 +22546,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -21481,9 +22579,9 @@ paths: application/json: schema: type: array - items: *178 + items: *194 examples: - default: &179 + default: &195 value: - id: 1 name: Justice League @@ -21539,6 +22637,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -21557,9 +22667,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21577,7 +22687,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &180 + - &196 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -21596,7 +22706,7 @@ paths: type: array items: *4 examples: - default: &181 + default: &197 value: - login: octocat id: 1 @@ -21635,7 +22745,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *180 + - *196 requestBody: required: true content: @@ -21666,7 +22776,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21684,7 +22794,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *180 + - *196 requestBody: required: true content: @@ -21715,7 +22825,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21733,8 +22843,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '200': description: User is a member of the enterprise team. @@ -21742,7 +22852,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &183 + exampleKey1: &199 value: login: octocat id: 1 @@ -21778,8 +22888,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '201': description: Successfully added team member @@ -21787,7 +22897,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *183 + exampleKey1: *199 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -21805,8 +22915,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *180 - - *182 + - *196 + - *198 responses: '204': description: Response @@ -21816,6 +22926,227 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - *41 + - *196 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: *69 + examples: + default: &200 + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - *41 + - *196 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: *69 + examples: + default: &237 + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - *41 + - *196 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *69 + examples: + default: *200 + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *69 + examples: + default: *200 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - *41 + - *196 + - *83 + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -21831,7 +23162,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &184 + - &201 name: team_slug description: The slug of the team name. in: path @@ -21843,9 +23174,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 headers: Link: *43 '403': *29 @@ -21865,7 +23196,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *184 + - *201 requestBody: required: true content: @@ -21891,6 +23222,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -21908,9 +23251,9 @@ paths: description: Response content: application/json: - schema: *178 + schema: *194 examples: - default: *179 + default: *195 headers: Link: *43 '403': *29 @@ -21933,7 +23276,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *184 + - *201 responses: '204': description: Response @@ -22032,7 +23375,7 @@ paths: application/json: schema: type: array - items: &215 + items: &232 title: Event description: Event type: object @@ -22042,7 +23385,7 @@ paths: type: type: string nullable: true - actor: &185 + actor: &202 title: Actor description: Actor type: object @@ -22082,7 +23425,7 @@ paths: - id - name - url - org: *185 + org: *202 payload: oneOf: - title: CreateEvent @@ -22128,7 +23471,7 @@ paths: properties: action: type: string - discussion: &854 + discussion: &872 title: Discussion description: A Discussion in a repository. type: object @@ -22415,7 +23758,7 @@ paths: - id labels: type: array - items: &188 + items: &205 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -22490,12 +23833,12 @@ paths: properties: action: type: string - issue: &189 + issue: &206 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &640 + properties: &657 id: type: integer format: int64 @@ -22609,7 +23952,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &380 + properties: &398 url: type: string format: uri @@ -22679,7 +24022,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &381 + required: &399 - closed_issues - creator - description @@ -22758,7 +24101,7 @@ paths: timeline_url: type: string format: uri - type: &342 + type: &360 title: Issue Type description: The type of issue. type: object @@ -22808,7 +24151,7 @@ paths: - node_id - name - description - repository: *69 + repository: *74 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -22819,9 +24162,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - author_association: &190 + properties: *203 + required: *204 + author_association: &207 title: author_association type: string example: OWNER @@ -22836,7 +24179,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &191 + reactions: &208 title: Reaction Rollup type: object properties: @@ -22872,7 +24215,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &775 + sub_issues_summary: &794 title: Sub-issues Summary type: object properties: @@ -22892,7 +24235,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &776 + issue_dependencies_summary: &795 title: Issue Dependencies Summary type: object properties: @@ -22911,7 +24254,7 @@ paths: - total_blocking issue_field_values: type: array - items: &777 + items: &796 title: Issue Field Value description: A value assigned to an issue field type: object @@ -22972,7 +24315,7 @@ paths: - node_id - data_type - value - required: &641 + required: &658 - assignee - closed_at - comments @@ -22997,10 +24340,10 @@ paths: assignees: type: array items: *4 - label: *188 + label: *205 labels: type: array - items: *188 + items: *205 required: - action - issue @@ -23009,8 +24352,8 @@ paths: properties: action: type: string - issue: *189 - comment: &638 + issue: *206 + comment: &655 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -23058,7 +24401,7 @@ paths: issue_url: type: string format: uri - author_association: *190 + author_association: *207 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -23069,9 +24412,9 @@ paths: actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - id - node_id @@ -23244,8 +24587,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true allow_forking: type: boolean @@ -23334,7 +24677,7 @@ paths: type: string number: type: integer - pull_request: &194 + pull_request: &211 title: Pull Request Minimal type: object properties: @@ -23405,10 +24748,10 @@ paths: assignees: type: array items: *4 - label: *188 + label: *205 labels: type: array - items: *188 + items: *205 required: - action - number @@ -23418,7 +24761,7 @@ paths: properties: action: type: string - pull_request: *194 + pull_request: *211 comment: type: object properties: @@ -23669,7 +25012,7 @@ paths: - pull_request updated_at: type: string - pull_request: *194 + pull_request: *211 required: - action - review @@ -23718,7 +25061,7 @@ paths: updated_at: type: string format: date-time - reactions: *191 + reactions: *208 required: - action - comment @@ -23729,7 +25072,7 @@ paths: type: string release: allOf: - - &693 + - &712 title: Release description: A release. type: object @@ -23800,7 +25143,7 @@ paths: author: *4 assets: type: array - items: &694 + items: &713 title: Release Asset description: Data related to a release. type: object @@ -23875,7 +25218,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *191 + reactions: *208 required: - assets_url - upload_url @@ -23967,7 +25310,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24048,7 +25391,7 @@ paths: _links: type: object properties: - timeline: &195 + timeline: &212 title: Link With Type description: Hypermedia Link with Type type: object @@ -24060,17 +25403,17 @@ paths: required: - href - type - user: *195 - security_advisories: *195 - current_user: *195 - current_user_public: *195 - current_user_actor: *195 - current_user_organization: *195 + user: *212 + security_advisories: *212 + current_user: *212 + current_user_public: *212 + current_user_actor: *212 + current_user_organization: *212 current_user_organizations: type: array - items: *195 - repository_discussions: *195 - repository_discussions_category: *195 + items: *212 + repository_discussions: *212 + repository_discussions_category: *212 required: - timeline - user @@ -24132,7 +25475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24142,7 +25485,7 @@ paths: application/json: schema: type: array - items: &197 + items: &214 title: Base Gist description: Base Gist type: object @@ -24241,7 +25584,7 @@ paths: - created_at - updated_at examples: - default: &198 + default: &215 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -24362,7 +25705,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &216 title: Gist Simple description: Gist Simple type: object @@ -24379,7 +25722,7 @@ paths: url: type: string format: uri - user: &789 + user: &808 title: Public User description: Public User type: object @@ -24741,7 +26084,7 @@ paths: truncated: type: boolean examples: - default: &200 + default: &217 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -24845,7 +26188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24855,9 +26198,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '422': *15 @@ -24879,7 +26222,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *196 + - *213 - *17 - *19 responses: @@ -24889,9 +26232,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '401': *25 @@ -24919,7 +26262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &201 + - &218 name: gist_id description: The unique identifier of the gist. in: path @@ -24931,10 +26274,10 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - default: *200 - '403': &204 + default: *217 + '403': &221 description: Forbidden Gist content: application/json: @@ -24982,7 +26325,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *201 + - *218 requestBody: required: true content: @@ -25042,9 +26385,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - updateGist: *200 + updateGist: *217 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -25202,7 +26545,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25231,7 +26574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25241,7 +26584,7 @@ paths: application/json: schema: type: array - items: &202 + items: &219 title: Gist Comment description: A comment made to a gist. type: object @@ -25276,7 +26619,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *190 + author_association: *207 required: - url - id @@ -25341,7 +26684,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *201 + - *218 requestBody: required: true content: @@ -25366,9 +26709,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: &203 + default: &220 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -25426,8 +26769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *201 - - &205 + - *218 + - &222 name: comment_id description: The unique identifier of the comment. in: path @@ -25440,12 +26783,12 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: *203 + default: *220 '304': *37 '404': *6 - '403': *204 + '403': *221 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25467,8 +26810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *201 - - *205 + - *218 + - *222 requestBody: required: true content: @@ -25493,9 +26836,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *219 examples: - default: *203 + default: *220 '404': *6 x-github: githubCloudOnly: false @@ -25512,8 +26855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *201 - - *205 + - *218 + - *222 responses: '204': description: Response @@ -25536,7 +26879,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25637,7 +26980,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *201 + - *218 - *17 - *19 responses: @@ -25647,7 +26990,7 @@ paths: application/json: schema: type: array - items: *199 + items: *216 examples: default: value: @@ -25712,13 +27055,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *201 + - *218 responses: '201': description: Response content: application/json: - schema: *197 + schema: *214 examples: default: value: @@ -25789,7 +27132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *201 + - *218 responses: '204': description: Response if gist is starred @@ -25819,7 +27162,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25841,7 +27184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *201 + - *218 responses: '204': description: Response @@ -25870,7 +27213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *201 + - *218 - name: sha in: path required: true @@ -25881,9 +27224,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *216 examples: - default: *200 + default: *217 '422': *15 '404': *6 '403': *29 @@ -26042,7 +27385,7 @@ paths: type: integer repositories: type: array - items: *69 + items: *74 repository_selection: type: string example: selected @@ -26249,7 +27592,7 @@ paths: - closed - all default: open - - &345 + - &363 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -26267,8 +27610,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - name: collab in: query required: false @@ -26298,9 +27641,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: &346 + default: &364 value: - id: 1 node_id: MDU6SXNzdWUx @@ -26584,8 +27927,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 examples: default: value: @@ -26870,7 +28213,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &206 + X-CommonMarker-Version: &223 example: 0.17.4 schema: type: string @@ -26925,7 +28268,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *206 + X-CommonMarker-Version: *223 content: text/html: schema: @@ -26954,7 +28297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &209 + - &226 name: account_id description: account_id parameter in: path @@ -26966,7 +28309,7 @@ paths: description: Response content: application/json: - schema: &208 + schema: &225 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -26996,7 +28339,7 @@ paths: nullable: true id: type: integer - plan: &207 + plan: &224 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27085,7 +28428,7 @@ paths: nullable: true updated_at: type: string - plan: *207 + plan: *224 required: - url - id @@ -27093,7 +28436,7 @@ paths: - login - marketplace_purchase examples: - default: &210 + default: &227 value: url: https://api.github.com/orgs/github type: Organization @@ -27178,9 +28521,9 @@ paths: application/json: schema: type: array - items: *207 + items: *224 examples: - default: &211 + default: &228 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -27220,14 +28563,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &212 + - &229 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &213 + - &230 name: sort description: The property to sort the results by. in: query @@ -27257,9 +28600,9 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: - default: &214 + default: &231 value: - url: https://api.github.com/orgs/github type: Organization @@ -27333,15 +28676,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *209 + - *226 responses: '200': description: Response content: application/json: - schema: *208 + schema: *225 examples: - default: *210 + default: *227 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -27373,9 +28716,9 @@ paths: application/json: schema: type: array - items: *207 + items: *224 examples: - default: *211 + default: *228 headers: Link: *43 '401': *25 @@ -27398,8 +28741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *212 - - *213 + - *229 + - *230 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -27419,9 +28762,9 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: - default: *214 + default: *231 headers: Link: *43 '401': *25 @@ -27685,14 +29028,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &446 + - &463 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &447 + - &464 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -27709,7 +29052,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -27754,7 +29097,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &460 + '301': &477 description: Moved permanently content: application/json: @@ -27776,7 +29119,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &669 + - &686 name: all description: If `true`, show notifications marked as read. in: query @@ -27784,7 +29127,7 @@ paths: schema: type: boolean default: false - - &670 + - &687 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -27793,8 +29136,8 @@ paths: schema: type: boolean default: false - - *196 - - &671 + - *213 + - &688 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -27819,18 +29162,18 @@ paths: application/json: schema: type: array - items: &216 + items: &233 title: Thread description: Thread type: object properties: id: type: string - repository: &255 + repository: &275 title: Minimal Repository description: Minimal Repository type: object - properties: &315 + properties: &333 id: type: integer format: int64 @@ -28106,7 +29449,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &392 + security_and_analysis: &409 nullable: true type: object properties: @@ -28188,7 +29531,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &316 + required: &334 - archive_url - assignees_url - blobs_url @@ -28276,7 +29619,7 @@ paths: - url - subscription_url examples: - default: &672 + default: &689 value: - id: '1' repository: @@ -28442,7 +29785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &217 + - &234 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -28456,7 +29799,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *233 examples: default: value: @@ -28559,7 +29902,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *217 + - *234 responses: '205': description: Reset Content @@ -28582,7 +29925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *217 + - *234 responses: '204': description: No content @@ -28605,13 +29948,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *217 + - *234 responses: '200': description: Response content: application/json: - schema: &218 + schema: &235 title: Thread Subscription description: Thread Subscription type: object @@ -28648,7 +29991,7 @@ paths: - url - subscribed examples: - default: &219 + default: &236 value: subscribed: true ignored: false @@ -28679,7 +30022,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *217 + - *234 requestBody: required: false content: @@ -28700,9 +30043,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *235 examples: - default: *219 + default: *236 '304': *37 '403': *29 '401': *25 @@ -28725,7 +30068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *217 + - *234 responses: '204': description: Response @@ -28820,22 +30163,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: &806 - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default: *237 headers: Link: example: ; rel="next" @@ -28886,7 +30216,7 @@ paths: type: integer custom_roles: type: array - items: &298 + items: &318 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -28934,7 +30264,7 @@ paths: - created_at - updated_at examples: - default: &299 + default: &319 value: id: 8030 name: Security Engineer @@ -28981,7 +30311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *78 + - *83 - name: page in: query description: The page number of results to fetch. @@ -29025,8 +30355,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *220 - required: *221 + properties: *238 + required: *239 nullable: true additionalProperties: false examples: @@ -29132,7 +30462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -29198,7 +30528,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *78 + - *83 requestBody: required: true content: @@ -29231,12 +30561,113 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *144 + examples: + default: &695 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - *83 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: *144 + required: + - properties + examples: + default: &696 + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -29244,13 +30675,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *78 - - *173 - - *222 - - *174 - - *223 - - *224 - - *225 + - *83 + - *189 + - *240 + - *190 + - *241 + - *242 + - *243 responses: '200': description: Response when getting a billing premium request usage report @@ -29306,19 +30737,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -29361,7 +30792,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29381,23 +30812,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *78 - - *173 - - *226 - - *174 - - *227 + - *83 + - *189 + - *244 + - *190 + - *245 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *228 + schema: *246 examples: - default: *229 + default: *247 '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29423,13 +30854,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &230 + schema: &248 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -29762,7 +31193,7 @@ paths: - updated_at - archived_at examples: - default-response: &231 + default-response: &249 value: login: github id: 1 @@ -29864,7 +31295,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *78 + - *83 requestBody: required: false content: @@ -30087,18 +31518,18 @@ paths: description: Response content: application/json: - schema: *230 + schema: *248 examples: - default: *231 + default: *249 '422': description: Validation failed content: application/json: schema: oneOf: - - *232 - - *233 - '409': *109 + - *250 + - *251 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30121,7 +31552,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *78 + - *83 responses: '202': *39 '404': *6 @@ -30146,15 +31577,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *234 + schema: *252 examples: - default: *235 + default: *253 headers: Link: *43 x-github: @@ -30177,7 +31608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -30195,7 +31626,7 @@ paths: type: integer repository_cache_usages: type: array - items: &465 + items: &482 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -30250,7 +31681,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -30270,7 +31701,7 @@ paths: type: array items: *44 examples: - default: *236 + default: *254 headers: Link: *43 x-github: @@ -30290,7 +31721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -30319,6 +31750,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -30336,6 +31772,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -30359,12 +31800,195 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: *45 + examples: + default: *47 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - *83 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: *45 + examples: + default: *255 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - *83 + - *46 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - *46 + - *83 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: *48 + examples: + default: *47 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - *83 + - *46 + - *49 + responses: + '200': + description: Response + content: + application/json: + schema: *48 + examples: + default: *256 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - *83 + - *46 + - *49 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -30377,7 +32001,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30393,9 +32017,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30413,7 +32037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30429,9 +32053,9 @@ paths: type: integer images: type: array - items: *45 + items: *50 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30448,15 +32072,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *237 + schema: *257 examples: - default: *238 + default: *258 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30474,7 +32098,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30490,9 +32114,9 @@ paths: type: integer machine_specs: type: array - items: *47 + items: *52 examples: - default: *239 + default: *259 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30510,7 +32134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30554,8 +32178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 responses: '200': description: Response @@ -30563,7 +32187,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 headers: Link: *43 x-github: @@ -30583,8 +32207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 requestBody: required: true content: @@ -30610,6 +32234,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -30624,7 +32253,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -30640,8 +32269,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *78 - - *49 + - *83 + - *54 responses: '202': description: Response @@ -30649,7 +32278,7 @@ paths: application/json: schema: *44 examples: - default: *48 + default: *53 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -30669,13 +32298,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *78 + - *83 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &240 + schema: &260 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -30689,7 +32318,7 @@ paths: required: - include_claim_keys examples: - default: &241 + default: &261 value: include_claim_keys: - repo @@ -30711,20 +32340,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *240 + schema: *260 examples: - default: *241 + default: *261 responses: '201': description: Empty response content: application/json: - schema: &266 + schema: &286 title: Empty Object description: An object without any properties. type: object @@ -30754,7 +32383,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -30763,7 +32392,7 @@ paths: schema: type: object properties: - enabled_repositories: &243 + enabled_repositories: &263 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -30776,9 +32405,9 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: *51 - selected_actions_url: *242 - sha_pinning_required: *52 + allowed_actions: *56 + selected_actions_url: *262 + sha_pinning_required: *57 required: - enabled_repositories examples: @@ -30808,7 +32437,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -30819,9 +32448,9 @@ paths: schema: type: object properties: - enabled_repositories: *243 - allowed_actions: *51 - sha_pinning_required: *52 + enabled_repositories: *263 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled_repositories examples: @@ -30849,13 +32478,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: response: summary: Example response @@ -30881,12 +32510,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *245 + schema: *265 examples: application/json: value: @@ -30896,7 +32525,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -30916,15 +32545,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *53 + schema: *58 examples: - default: *246 + default: *266 '404': *6 x-github: enabledForGitHubApps: true @@ -30943,7 +32572,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -30953,7 +32582,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -30975,15 +32604,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *247 + schema: *267 examples: - default: *54 + default: *59 '403': *29 '404': *6 x-github: @@ -31001,14 +32630,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *248 + schema: *268 examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -31038,7 +32667,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -31056,9 +32685,9 @@ paths: type: number repositories: type: array - items: *69 + items: *74 examples: - default: &250 + default: &270 value: total_count: 1 repositories: @@ -31198,7 +32827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -31242,8 +32871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *78 - - &249 + - *83 + - &269 name: repository_id description: The unique identifier of the repository. in: path @@ -31271,8 +32900,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -31295,15 +32924,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *56 + schema: *61 examples: - default: *57 + default: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31326,7 +32955,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -31334,9 +32963,9 @@ paths: required: false content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31356,7 +32985,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -31404,7 +33033,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31431,7 +33060,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31451,7 +33080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -31466,9 +33095,9 @@ paths: type: integer repositories: type: array - items: *69 + items: *74 examples: - default: *250 + default: *270 '403': *29 '404': *6 x-github: @@ -31488,7 +33117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31536,14 +33165,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31563,14 +33192,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: No content '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 x-github: enabledForGitHubApps: true @@ -31592,15 +33221,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *251 + schema: *271 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31621,7 +33250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Success response @@ -31632,9 +33261,9 @@ paths: required: false content: application/json: - schema: *252 + schema: *272 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31654,7 +33283,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *78 + - *83 - *17 - *19 - name: visible_to_repository @@ -31679,7 +33308,7 @@ paths: type: number runner_groups: type: array - items: &253 + items: &273 type: object properties: id: @@ -31795,7 +33424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -31867,9 +33496,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *273 examples: - default: &254 + default: &274 value: id: 2 name: octo-runner-group @@ -31904,14 +33533,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 responses: '200': description: Response content: application/json: - schema: *253 + schema: *273 examples: default: value: @@ -31947,8 +33576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32002,9 +33631,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *273 examples: - default: *254 + default: *274 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32023,8 +33652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *78 - - *63 + - *83 + - *68 responses: '204': description: Response @@ -32047,8 +33676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *17 - *19 responses: @@ -32068,7 +33697,7 @@ paths: type: array items: *44 examples: - default: *236 + default: *254 headers: Link: *43 x-github: @@ -32090,8 +33719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *19 - *17 responses: @@ -32109,9 +33738,9 @@ paths: type: number repositories: type: array - items: *255 + items: *275 examples: - default: &792 + default: &811 value: total_count: 1 repositories: @@ -32363,8 +33992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32408,9 +34037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 - - *249 + - *83 + - *68 + - *269 responses: '204': description: Response @@ -32432,9 +34061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *78 - - *63 - - *249 + - *83 + - *68 + - *269 responses: '204': description: Response @@ -32457,8 +34086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 - *17 - *19 responses: @@ -32476,9 +34105,9 @@ paths: type: number runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -32499,8 +34128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *78 - - *63 + - *83 + - *68 requestBody: required: true content: @@ -32544,9 +34173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *78 - - *63 - - *66 + - *83 + - *68 + - *71 responses: '204': description: Response @@ -32568,9 +34197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *78 - - *63 - - *66 + - *83 + - *68 + - *71 responses: '204': description: Response @@ -32600,7 +34229,7 @@ paths: in: query schema: type: string - - *78 + - *83 - *17 - *19 responses: @@ -32618,9 +34247,9 @@ paths: type: integer runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -32644,7 +34273,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -32652,9 +34281,9 @@ paths: application/json: schema: type: array - items: *256 + items: *276 examples: - default: *257 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32676,7 +34305,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -32719,10 +34348,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *278 '404': *6 '422': *7 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32750,15 +34379,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *78 + - *83 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *259 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32786,15 +34415,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *78 + - *83 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32816,16 +34445,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: *261 + default: *281 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32846,8 +34475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: '204': description: Response @@ -32873,10 +34502,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: - '200': *72 + '200': *77 '404': *6 x-github: githubCloudOnly: false @@ -32898,8 +34527,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 requestBody: required: true content: @@ -32923,7 +34552,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -32947,8 +34576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 requestBody: required: true content: @@ -32973,7 +34602,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -32997,10 +34626,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 + - *83 + - *71 responses: - '200': *262 + '200': *282 '404': *6 x-github: githubCloudOnly: false @@ -33027,11 +34656,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *78 - - *66 - - *263 + - *83 + - *71 + - *283 responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -33056,7 +34685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -33074,7 +34703,7 @@ paths: type: integer secrets: type: array - items: &264 + items: &284 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -33147,13 +34776,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &485 + schema: &502 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -33182,7 +34811,7 @@ paths: - key_id - key examples: - default: &486 + default: &503 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33207,8 +34836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *78 - - &265 + - *83 + - &285 name: secret_name description: The name of the secret. in: path @@ -33220,7 +34849,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *284 examples: default: value: @@ -33250,8 +34879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -33308,7 +34937,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -33334,8 +34963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -33361,8 +34990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -33380,9 +35009,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: &269 + default: &289 value: total_count: 1 repositories: @@ -33474,8 +35103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -33527,8 +35156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -33561,8 +35190,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -33594,8 +35223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *78 - - &470 + - *83 + - &487 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -33619,7 +35248,7 @@ paths: type: integer variables: type: array - items: &267 + items: &287 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -33704,7 +35333,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *78 + - *83 requestBody: required: true content: @@ -33752,7 +35381,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -33777,8 +35406,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *78 - - &268 + - *83 + - &288 name: name description: The name of the variable. in: path @@ -33790,7 +35419,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *287 examples: default: value: @@ -33820,8 +35449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 requestBody: required: true content: @@ -33883,8 +35512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 responses: '204': description: Response @@ -33910,8 +35539,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - *19 - *17 responses: @@ -33929,9 +35558,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 '409': description: Response when the visibility of the variable is not set to `selected` @@ -33957,8 +35586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 requestBody: required: true content: @@ -34007,8 +35636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - name: repository_id in: path required: true @@ -34042,8 +35671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *78 - - *268 + - *83 + - *288 - name: repository_id in: path required: true @@ -34074,15 +35703,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34101,19 +35730,19 @@ paths: required: true content: application/json: - schema: *270 + schema: *290 examples: - default: *76 + default: *81 parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *77 + schema: *82 examples: - default: *76 + default: *81 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34129,7 +35758,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -34152,7 +35781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *78 + - *83 requestBody: required: true content: @@ -34284,7 +35913,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *78 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -34367,9 +35996,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *99 - - *100 - - *78 + - *104 + - *105 + - *83 requestBody: required: true content: @@ -34392,12 +36021,12 @@ paths: required: - subject_digests examples: - default: &821 + default: &839 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &822 + withPredicateType: &840 value: subject_digests: - sha256:abc123 @@ -34455,7 +36084,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &823 + default: &841 value: attestations_subject_digests: - sha256:abc: @@ -34564,7 +36193,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *78 + - *83 requestBody: required: true content: @@ -34629,7 +36258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *78 + - *83 - name: subject_digest description: Subject Digest in: path @@ -34648,6 +36277,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + parameters: + - *17 + - *104 + - *105 + - *83 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -34660,7 +36340,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *78 + - *83 - name: attestation_id description: Attestation ID in: path @@ -34696,9 +36376,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *99 - - *100 - - *78 + - *104 + - *105 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -34751,7 +36431,7 @@ paths: initiator: type: string examples: - default: &499 + default: &516 value: attestations: - bundle: @@ -34869,7 +36549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *78 + - *83 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -34877,10 +36557,10 @@ paths: required: false schema: type: string - - *271 - - *272 - - *273 - - *274 + - *291 + - *292 + - *293 + - *294 - *17 responses: '200': @@ -34889,9 +36569,9 @@ paths: application/json: schema: type: array - items: *275 + items: *295 examples: - default: *276 + default: *296 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34908,7 +36588,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -34920,7 +36600,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34939,8 +36619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: If the user is blocked @@ -34965,8 +36645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -34986,8 +36666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -35013,17 +36693,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *78 - - &279 + - *83 + - &299 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *94 - - *95 - - *96 - - *97 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -35033,9 +36713,9 @@ paths: application/json: schema: type: array - items: *277 + items: *297 examples: - default: *278 + default: *298 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -35058,12 +36738,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *78 - - *279 - - *94 - - *95 - - *96 - - *97 + - *83 + - *299 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -35073,9 +36753,9 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -35094,15 +36774,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *78 + - *83 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &283 + schema: &303 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -35128,7 +36808,7 @@ paths: application/json: schema: type: array - items: &284 + items: &304 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -35159,7 +36839,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *282 + items: *302 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -35177,7 +36857,7 @@ paths: type: string format: date-time nullable: true - state: *283 + state: *303 contact_link: description: The contact link of the campaign. type: string @@ -35274,7 +36954,7 @@ paths: headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35298,7 +36978,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -35362,6 +37042,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -35371,7 +37052,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -35392,9 +37077,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: &285 + default: &305 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -35443,7 +37128,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35465,7 +37150,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35477,16 +37162,16 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35507,7 +37192,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35556,7 +37241,7 @@ paths: type: string format: uri nullable: true - state: *283 + state: *303 examples: default: value: @@ -35566,9 +37251,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '400': description: Bad Request content: @@ -35580,7 +37265,7 @@ paths: content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35601,7 +37286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *78 + - *83 - name: campaign_number description: The campaign number. in: path @@ -35612,7 +37297,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35634,20 +37319,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *78 - - *286 - - *287 - - *99 - - *100 + - *83 + - *306 + - *307 + - *104 + - *105 - *19 - *17 - - *101 + - *106 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *288 + schema: *308 - name: sort description: The property by which to sort the results. in: query @@ -35663,7 +37348,7 @@ paths: be returned. in: query required: false - schema: &525 + schema: &542 type: string description: Severity of a code scanning alert. enum: @@ -35681,13 +37366,13 @@ paths: application/json: schema: type: array - items: *289 + items: *309 examples: - default: *290 + default: *310 headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35709,7 +37394,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *78 + - *83 - name: target_type in: query description: The target type of the code security configuration @@ -35728,8 +37413,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -35737,7 +37422,7 @@ paths: application/json: schema: type: array - items: *105 + items: *110 examples: default: value: @@ -35820,7 +37505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *78 + - *83 requestBody: required: true content: @@ -35898,7 +37583,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *291 + code_scanning_options: *311 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -35907,7 +37592,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36039,9 +37724,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *105 + schema: *110 examples: - default: *292 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36063,15 +37748,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *293 + schema: *313 examples: - default: *294 + default: *314 '304': *37 '403': *29 '404': *6 @@ -36097,7 +37782,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *78 + - *83 requestBody: required: true content: @@ -36123,11 +37808,11 @@ paths: - 32 - 91 responses: - '204': *133 + '204': *143 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36149,16 +37834,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 responses: '200': description: Response content: application/json: - schema: *105 + schema: *110 examples: - default: *292 + default: *312 '304': *37 '403': *29 '404': *6 @@ -36182,8 +37867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36262,7 +37947,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *108 + code_scanning_default_setup_options: *113 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36380,7 +38065,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *105 + schema: *110 examples: default: value: @@ -36439,14 +38124,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 responses: - '204': *133 + '204': *143 '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36470,8 +38155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36534,8 +38219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *78 - - *107 + - *83 + - *112 requestBody: required: true content: @@ -36575,12 +38260,12 @@ paths: - none - private_and_internal - public - configuration: *105 + configuration: *110 examples: default: value: default_for_new_repos: all - configuration: *292 + configuration: *312 '403': *29 '404': *6 x-github: @@ -36604,8 +38289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *78 - - *107 + - *83 + - *112 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -36614,8 +38299,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 + - *104 + - *105 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -36633,13 +38318,13 @@ paths: application/json: schema: type: array - items: *295 + items: *315 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *296 + repository: *316 '403': *29 '404': *6 x-github: @@ -36663,7 +38348,7 @@ paths: parameters: - *17 - *19 - - *78 + - *83 responses: '200': description: Response @@ -36679,7 +38364,7 @@ paths: type: integer codespaces: type: array - items: &347 + items: &365 type: object title: Codespace description: A codespace. @@ -36704,12 +38389,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *255 + repository: *275 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &554 + properties: &571 name: type: string description: The name of the machine. @@ -36751,7 +38436,7 @@ paths: - ready - in_progress nullable: true - required: &555 + required: &572 - name - display_name - operating_system @@ -36956,7 +38641,7 @@ paths: - pulls_url - recent_folders examples: - default: &348 + default: &366 value: total_count: 3 codespaces: @@ -37388,7 +39073,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *78 + - *83 deprecated: true requestBody: required: true @@ -37455,7 +39140,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *78 + - *83 deprecated: true requestBody: required: true @@ -37510,7 +39195,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *78 + - *83 requestBody: required: true content: @@ -37562,7 +39247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -37580,7 +39265,7 @@ paths: type: integer secrets: type: array - items: &297 + items: &317 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -37619,7 +39304,7 @@ paths: - updated_at - visibility examples: - default: &556 + default: &573 value: total_count: 2 secrets: @@ -37651,13 +39336,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &557 + schema: &574 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -37686,7 +39371,7 @@ paths: - key_id - key examples: - default: &558 + default: &575 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37709,16 +39394,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: Response content: application/json: - schema: *297 + schema: *317 examples: - default: &560 + default: &577 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -37745,8 +39430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -37801,7 +39486,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -37827,8 +39512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -37853,8 +39538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -37872,9 +39557,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 '404': *6 x-github: githubCloudOnly: false @@ -37896,8 +39581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -37947,8 +39632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -37981,8 +39666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -38021,7 +39706,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: OK @@ -38162,7 +39847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *78 + - *83 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -38185,9 +39870,9 @@ paths: currently being billed. seats: type: array - items: *124 + items: *134 examples: - default: *125 + default: *135 headers: Link: *43 '500': *40 @@ -38223,7 +39908,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38301,7 +39986,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38381,7 +40066,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38458,7 +40143,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *78 + - *83 requestBody: content: application/json: @@ -38539,7 +40224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *78 + - *83 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -38571,13 +40256,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38599,7 +40284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -38743,7 +40428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *78 + - *83 - name: credential_id in: path required: true @@ -38774,7 +40459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *78 + - *83 responses: '200': description: Response - list of custom role names @@ -38789,7 +40474,7 @@ paths: type: integer custom_roles: type: array - items: *298 + items: *318 examples: default: value: @@ -38876,12 +40561,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: &301 + schema: &321 type: object properties: name: @@ -38922,9 +40607,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -38948,8 +40633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *78 - - &300 + - *83 + - &320 name: role_id description: The unique identifier of the role. in: path @@ -38961,9 +40646,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '404': *6 x-github: githubCloudOnly: true @@ -38985,13 +40670,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: application/json: - schema: &302 + schema: &322 type: object properties: name: @@ -39029,9 +40714,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39055,8 +40740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -39084,12 +40769,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: *301 + schema: *321 examples: default: value: @@ -39103,9 +40788,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39135,16 +40820,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '200': description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '404': *6 x-github: githubCloudOnly: true @@ -39172,13 +40857,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: application/json: - schema: *302 + schema: *322 examples: default: value: @@ -39193,9 +40878,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *318 examples: - default: *299 + default: *319 '422': *15 '404': *6 x-github: @@ -39225,8 +40910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -39254,12 +40939,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *78 - - *303 - - *304 - - *305 - - *306 - - *307 + - *83 + - *323 + - *324 + - *325 + - *326 + - *327 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -39297,13 +40982,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *308 - - *309 - - *101 - - *99 - - *100 - - *310 - - *311 + - *328 + - *329 + - *106 + - *104 + - *105 - *17 responses: '200': @@ -39312,9 +40995,9 @@ paths: application/json: schema: type: array - items: *312 + items: *330 examples: - default: *313 + default: *331 '304': *37 '400': *14 '403': *29 @@ -39340,7 +41023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *78 + - *83 - *17 - *19 responses: @@ -39358,7 +41041,7 @@ paths: type: integer secrets: type: array - items: &314 + items: &332 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -39429,13 +41112,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: &586 + schema: &603 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -39452,7 +41135,7 @@ paths: - key_id - key examples: - default: &587 + default: &604 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39475,14 +41158,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: Response content: application/json: - schema: *314 + schema: *332 examples: default: value: @@ -39510,8 +41193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -39570,7 +41253,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -39594,8 +41277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -39619,8 +41302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - *19 - *17 responses: @@ -39638,9 +41321,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39661,8 +41344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -39712,8 +41395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -39744,8 +41427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *78 - - *265 + - *83 + - *285 - name: repository_id in: path required: true @@ -39781,8 +41464,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *78 - - &595 + - *83 + - &612 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -39790,7 +41473,7 @@ paths: required: false schema: type: string - - &596 + - &613 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -39798,7 +41481,7 @@ paths: required: false schema: type: string - - &597 + - &614 name: time_period description: |- The time period to filter by. @@ -39814,7 +41497,7 @@ paths: - week - month default: month - - &598 + - &615 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -39829,7 +41512,7 @@ paths: - denied - all default: all - - *279 + - *299 - *17 - *19 responses: @@ -39839,7 +41522,7 @@ paths: application/json: schema: type: array - items: &599 + items: &616 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -39995,7 +41678,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &600 + default: &617 value: - id: 21 number: 42 @@ -40081,12 +41764,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *78 - - *279 - - *94 - - *95 - - *96 - - &601 + - *83 + - *299 + - *99 + - *100 + - *101 + - &618 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -40112,7 +41795,7 @@ paths: application/json: schema: type: array - items: &602 + items: &619 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -40222,7 +41905,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *98 + items: *103 url: type: string format: uri @@ -40233,7 +41916,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &603 + default: &620 value: - id: 21 number: 42 @@ -40313,7 +41996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -40321,7 +42004,7 @@ paths: application/json: schema: type: array - items: &358 + items: &376 title: Package description: A software package type: object @@ -40371,8 +42054,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *315 - required: *316 + properties: *333 + required: *334 nullable: true created_at: type: string @@ -40391,7 +42074,7 @@ paths: - created_at - updated_at examples: - default: &359 + default: &377 value: - id: 197 name: hello_docker @@ -40469,7 +42152,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40479,7 +42162,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: 200-response: value: @@ -40552,7 +42235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *78 + - *83 - name: group_id description: The unique identifier of the group. in: path @@ -40578,7 +42261,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &458 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -40659,7 +42342,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &442 + default: &459 value: group_id: '123' group_name: Octocat admins @@ -40697,7 +42380,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -40714,7 +42397,7 @@ paths: description: Response content: application/json: - schema: &439 + schema: &456 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -40751,7 +42434,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &440 + default: &457 value: groups: - group_id: '123' @@ -40785,7 +42468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40795,7 +42478,7 @@ paths: application/json: schema: type: array - items: &339 + items: &357 title: Organization Invitation description: Organization Invitation type: object @@ -40842,7 +42525,7 @@ paths: - invitation_teams_url - node_id examples: - default: &340 + default: &358 value: - id: 1 login: monalisa @@ -40901,7 +42584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -40909,7 +42592,7 @@ paths: application/json: schema: type: array - items: &393 + items: &410 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -40923,7 +42606,7 @@ paths: - name - description examples: - default: &394 + default: &411 value: - name: add_assignee description: Assign or remove a user @@ -40954,7 +42637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *78 + - *83 - *17 - *19 responses: @@ -40964,7 +42647,7 @@ paths: application/json: schema: type: array - items: &317 + items: &335 title: Org Hook description: Org Hook type: object @@ -41073,7 +42756,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *78 + - *83 requestBody: required: true content: @@ -41133,9 +42816,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: - default: &318 + default: &336 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -41179,8 +42862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *78 - - &319 + - *83 + - &337 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -41193,9 +42876,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: - default: *318 + default: *336 '404': *6 x-github: githubCloudOnly: false @@ -41216,8 +42899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 requestBody: required: false content: @@ -41262,7 +42945,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *335 examples: default: value: @@ -41301,8 +42984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 responses: '204': description: Response @@ -41327,8 +43010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *78 - - *319 + - *83 + - *337 responses: '200': description: Response @@ -41356,8 +43039,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *78 - - *319 + - *83 + - *337 requestBody: required: false content: @@ -41405,10 +43088,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *17 - - *320 + - *338 responses: '200': description: Response @@ -41416,9 +43099,9 @@ paths: application/json: schema: type: array - items: *321 + items: *339 examples: - default: *322 + default: *340 '400': *14 '422': *15 x-github: @@ -41441,17 +43124,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *16 responses: '200': description: Response content: application/json: - schema: *323 + schema: *341 examples: - default: *324 + default: *342 '400': *14 '422': *15 x-github: @@ -41474,8 +43157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 - *16 responses: '202': *39 @@ -41501,8 +43184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *78 - - *319 + - *83 + - *337 responses: '204': description: Response @@ -41524,8 +43207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *78 - - &329 + - *83 + - &347 name: actor_type in: path description: The type of the actor @@ -41538,14 +43221,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &330 + - &348 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &325 + - &343 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -41553,7 +43236,7 @@ paths: required: true schema: type: string - - &326 + - &344 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -41564,7 +43247,7 @@ paths: type: string - *19 - *17 - - *101 + - *106 - name: sort description: The property to sort the results by. in: query @@ -41646,13 +43329,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *78 - - *325 - - *326 + - *83 + - *343 + - *344 - *19 - *17 - - *101 - - &335 + - *106 + - &353 name: sort description: The property to sort the results by. in: query @@ -41730,15 +43413,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *78 - - *325 - - *326 + - *83 + - *343 + - *344 responses: '200': description: Response content: application/json: - schema: &327 + schema: &345 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -41754,7 +43437,7 @@ paths: type: integer format: int64 examples: - default: &328 + default: &346 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -41774,24 +43457,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *78 - - &331 + - *83 + - &349 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *325 - - *326 + - *343 + - *344 responses: '200': description: Response content: application/json: - schema: *327 + schema: *345 examples: - default: *328 + default: *346 x-github: enabledForGitHubApps: true category: orgs @@ -41809,19 +43492,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *78 - - *325 - - *326 - - *329 - - *330 + - *83 + - *343 + - *344 + - *347 + - *348 responses: '200': description: Response content: application/json: - schema: *327 + schema: *345 examples: - default: *328 + default: *346 x-github: enabledForGitHubApps: true category: orgs @@ -41838,10 +43521,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *78 - - *325 - - *326 - - &332 + - *83 + - *343 + - *344 + - &350 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -41854,7 +43537,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &351 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -41870,7 +43553,7 @@ paths: type: integer format: int64 examples: - default: &334 + default: &352 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -41906,19 +43589,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *78 - - *331 - - *325 - - *326 - - *332 + - *83 + - *349 + - *343 + - *344 + - *350 responses: '200': description: Response content: application/json: - schema: *333 + schema: *351 examples: - default: *334 + default: *352 x-github: enabledForGitHubApps: true category: orgs @@ -41935,20 +43618,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *78 - - *329 - - *330 - - *325 - - *326 - - *332 + - *83 + - *347 + - *348 + - *343 + - *344 + - *350 responses: '200': description: Response content: application/json: - schema: *333 + schema: *351 examples: - default: *334 + default: *352 x-github: enabledForGitHubApps: true category: orgs @@ -41965,14 +43648,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *78 - - *331 - - *325 - - *326 + - *83 + - *349 + - *343 + - *344 - *19 - *17 - - *101 - - *335 + - *106 + - *353 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -42045,7 +43728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *78 + - *83 responses: '200': description: Response @@ -42053,7 +43736,7 @@ paths: application/json: schema: *22 examples: - default: &634 + default: &651 value: id: 1 account: @@ -42122,7 +43805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -42211,7 +43894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -42219,12 +43902,12 @@ paths: application/json: schema: anyOf: - - &337 + - &355 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &336 + limit: &354 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -42249,7 +43932,7 @@ paths: properties: {} additionalProperties: false examples: - default: &338 + default: &356 value: limit: collaborators_only origin: organization @@ -42273,18 +43956,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: application/json: - schema: &635 + schema: &652 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *336 + limit: *354 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -42308,9 +43991,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: - default: *338 + default: *356 '422': *15 x-github: githubCloudOnly: false @@ -42328,7 +44011,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -42354,7 +44037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *78 + - *83 - *17 - *19 - name: role @@ -42388,9 +44071,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 '404': *6 @@ -42414,7 +44097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *78 + - *83 requestBody: required: false content: @@ -42468,7 +44151,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -42524,8 +44207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *78 - - &341 + - *83 + - &359 name: invitation_id description: The unique identifier of the invitation. in: path @@ -42558,8 +44241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *78 - - *341 + - *83 + - *359 - *17 - *19 responses: @@ -42569,9 +44252,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: &357 + default: &375 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -42606,7 +44289,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -42614,7 +44297,7 @@ paths: application/json: schema: type: array - items: *342 + items: *360 examples: default: value: @@ -42652,7 +44335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -42699,9 +44382,9 @@ paths: description: Response content: application/json: - schema: *342 + schema: *360 examples: - default: &343 + default: &361 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -42733,8 +44416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *78 - - &344 + - *83 + - &362 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -42787,9 +44470,9 @@ paths: description: Response content: application/json: - schema: *342 + schema: *360 examples: - default: *343 + default: *361 '404': *6 '422': *7 x-github: @@ -42813,8 +44496,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *78 - - *344 + - *83 + - *362 responses: '204': description: Response @@ -42847,7 +44530,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *78 + - *83 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -42877,7 +44560,7 @@ paths: - closed - all default: open - - *345 + - *363 - name: type description: Can be the name of an issue type. in: query @@ -42895,8 +44578,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -42906,9 +44589,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *346 + default: *364 headers: Link: *43 '404': *6 @@ -42930,7 +44613,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *78 + - *83 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -42968,7 +44651,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '422': *15 @@ -42988,8 +44671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response if requester is an organization member and user is @@ -43023,8 +44706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -43050,8 +44733,8 @@ paths: parameters: - *17 - *19 - - *78 - - *182 + - *83 + - *198 responses: '200': description: Response @@ -43067,9 +44750,9 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: - default: *348 + default: *366 '304': *37 '500': *40 '401': *25 @@ -43094,9 +44777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *78 - - *182 - - &349 + - *83 + - *198 + - &367 name: codespace_name in: path required: true @@ -43129,17 +44812,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *78 - - *182 - - *349 + - *83 + - *198 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: &553 + default: &570 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -43312,14 +44995,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *124 + schema: *134 examples: default: value: @@ -43388,14 +45071,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '200': description: Response content: application/json: - schema: &350 + schema: &368 title: Org Membership description: Org Membership type: object @@ -43439,7 +45122,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *64 + organization: *69 user: title: Simple User description: A GitHub user. @@ -43462,7 +45145,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &351 + response-if-user-has-an-active-admin-membership-with-organization: &369 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -43530,8 +45213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 requestBody: required: false content: @@ -43559,9 +45242,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: - response-if-user-already-had-membership-with-organization: *351 + response-if-user-already-had-membership-with-organization: *369 '422': *15 '403': *29 x-github: @@ -43585,8 +45268,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -43611,7 +45294,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *78 + - *83 - *17 - *19 - name: exclude @@ -43632,7 +45315,7 @@ paths: application/json: schema: type: array - items: &352 + items: &370 title: Migration description: A migration. type: object @@ -43673,7 +45356,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *69 + items: *74 url: type: string format: uri @@ -43885,7 +45568,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *78 + - *83 requestBody: required: true content: @@ -43961,7 +45644,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -44139,8 +45822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *78 - - &353 + - *83 + - &371 name: migration_id description: The unique identifier of the migration. in: path @@ -44167,7 +45850,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -44336,8 +46019,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *78 - - *353 + - *83 + - *371 responses: '302': description: Response @@ -44358,8 +46041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *78 - - *353 + - *83 + - *371 responses: '204': description: Response @@ -44382,9 +46065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *78 - - *353 - - &805 + - *83 + - *371 + - &824 name: repo_name description: repo_name parameter in: path @@ -44411,8 +46094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *78 - - *353 + - *83 + - *371 - *17 - *19 responses: @@ -44422,9 +46105,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: &364 + default: &382 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44563,7 +46246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -44617,7 +46300,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response - list of organization roles @@ -44633,7 +46316,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &354 + items: &372 title: Organization Role description: Organization roles type: object @@ -44793,7 +46476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *78 + - *83 requestBody: required: true content: @@ -44840,7 +46523,7 @@ paths: description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -44869,7 +46552,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -44891,8 +46574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -44917,9 +46600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *78 - - *184 - - *300 + - *83 + - *201 + - *320 responses: '204': description: Response @@ -44948,9 +46631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *78 - - *184 - - *300 + - *83 + - *201 + - *320 responses: '204': description: Response @@ -44975,8 +46658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -45001,9 +46684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *78 - - *182 - - *300 + - *83 + - *198 + - *320 responses: '204': description: Response @@ -45033,9 +46716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *78 - - *182 - - *300 + - *83 + - *198 + - *320 responses: '204': description: Response @@ -45063,14 +46746,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '200': description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -45127,8 +46810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *78 - - *300 + - *83 + - *320 requestBody: required: true content: @@ -45167,7 +46850,7 @@ paths: description: Response content: application/json: - schema: *354 + schema: *372 examples: default: value: @@ -45195,7 +46878,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *109 + '409': *114 '404': *6 x-github: githubCloudOnly: true @@ -45220,8 +46903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *78 - - *300 + - *83 + - *320 responses: '204': description: Response @@ -45246,8 +46929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 - *17 - *19 responses: @@ -45325,8 +47008,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 nullable: true type: description: The ownership type of the team @@ -45358,7 +47041,7 @@ paths: - type - parent examples: - default: *357 + default: *375 headers: Link: *43 '404': @@ -45387,8 +47070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *78 - - *300 + - *83 + - *320 - *17 - *19 responses: @@ -45416,13 +47099,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &413 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 name: nullable: true type: string @@ -45517,7 +47200,7 @@ paths: - type - url examples: - default: *181 + default: *197 headers: Link: *43 '404': @@ -45541,7 +47224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *78 + - *83 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -45568,7 +47251,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -45593,8 +47276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *78 - - *182 + - *83 + - *198 requestBody: required: false content: @@ -45651,8 +47334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -45709,8 +47392,8 @@ paths: - docker - nuget - container - - *78 - - &807 + - *83 + - &825 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -45746,12 +47429,12 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *359 + default: *377 '403': *29 '401': *25 - '400': &809 + '400': &827 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45773,7 +47456,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &360 + - &378 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -45791,20 +47474,20 @@ paths: - docker - nuget - container - - &361 + - &379 name: package_name description: The name of the package. in: path required: true schema: type: string - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: default: value: @@ -45856,9 +47539,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 responses: '204': description: Response @@ -45890,9 +47573,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 - name: token description: package token schema: @@ -45924,9 +47607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *360 - - *361 - - *78 + - *378 + - *379 + - *83 - *19 - *17 - name: state @@ -45946,7 +47629,7 @@ paths: application/json: schema: type: array - items: &362 + items: &380 title: Package Version description: A version of a software package type: object @@ -46071,10 +47754,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - &363 + - *378 + - *379 + - *83 + - &381 name: package_version_id description: Unique identifier of the package version. in: path @@ -46086,7 +47769,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -46122,10 +47805,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - *363 + - *378 + - *379 + - *83 + - *381 responses: '204': description: Response @@ -46157,10 +47840,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *360 - - *361 - - *78 - - *363 + - *378 + - *379 + - *83 + - *381 responses: '204': description: Response @@ -46187,10 +47870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *78 + - *83 - *17 - *19 - - &365 + - &383 name: sort description: The property by which to sort the results. in: query @@ -46200,8 +47883,8 @@ paths: enum: - created_at default: created_at - - *101 - - &366 + - *106 + - &384 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -46212,7 +47895,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &367 + - &385 name: repository description: The name of the repository to use to filter the results. in: query @@ -46220,7 +47903,7 @@ paths: schema: type: string example: Hello-World - - &368 + - &386 name: permission description: The permission to use to filter the results. in: query @@ -46228,7 +47911,7 @@ paths: schema: type: string example: issues_read - - &369 + - &387 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -46238,7 +47921,7 @@ paths: schema: type: string format: date-time - - &370 + - &388 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -46248,7 +47931,7 @@ paths: schema: type: string format: date-time - - &371 + - &389 name: token_id description: The ID of the token in: query @@ -46412,7 +48095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *78 + - *83 requestBody: required: true content: @@ -46478,7 +48161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *78 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -46518,7 +48201,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46539,7 +48222,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *78 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -46559,9 +48242,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -46584,17 +48267,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *78 + - *83 - *17 - *19 - - *365 - - *101 - - *366 - - *367 - - *368 - - *369 - - *370 - - *371 + - *383 + - *106 + - *384 + - *385 + - *386 + - *387 + - *388 + - *389 responses: '500': *40 '422': *15 @@ -46743,7 +48426,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *78 + - *83 requestBody: required: true content: @@ -46803,7 +48486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *78 + - *83 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -46833,7 +48516,7 @@ paths: responses: '500': *40 '404': *6 - '204': *133 + '204': *143 '403': *29 '422': *15 x-github: @@ -46855,7 +48538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *78 + - *83 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -46874,9 +48557,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -46900,7 +48583,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -46918,7 +48601,7 @@ paths: type: integer configurations: type: array - items: &372 + items: &390 title: Organization private registry description: Private registry configuration for an organization type: object @@ -47006,7 +48689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -47171,7 +48854,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &373 + org-private-registry-with-selected-visibility: &391 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -47212,7 +48895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -47260,16 +48943,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 '404': *6 x-github: githubCloudOnly: false @@ -47290,8 +48973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 requestBody: required: true content: @@ -47386,8 +49069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *78 - - *265 + - *83 + - *285 responses: '204': description: Response @@ -47412,7 +49095,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *78 + - *83 - name: state description: Indicates the state of the projects to return. in: query @@ -47433,7 +49116,7 @@ paths: application/json: schema: type: array - items: &374 + items: &392 title: Project description: Projects are a way to organize columns and cards of work. @@ -47580,7 +49263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *78 + - *83 requestBody: required: true content: @@ -47606,7 +49289,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: default: value: @@ -47644,7 +49327,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &457 + '410': &474 description: Gone content: application/json: @@ -47670,15 +49353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *78 + - *83 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *99 - - *100 + - *104 + - *105 - *17 responses: '200': @@ -47687,7 +49370,7 @@ paths: application/json: schema: type: array - items: &375 + items: &393 title: Projects v2 Project description: A projects v2 project type: object @@ -47757,7 +49440,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &885 + properties: &903 id: type: number description: The unique identifier of the status update. @@ -47805,7 +49488,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &886 + required: &904 - id - node_id - created_at @@ -47830,7 +49513,7 @@ paths: - deleted_at - deleted_by examples: - default: &376 + default: &394 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -47933,22 +49616,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &377 + - &395 name: project_number description: The project's number. in: path required: true schema: type: integer - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *375 + schema: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -47970,11 +49653,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *377 - - *78 + - *395 + - *83 - *17 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -47982,7 +49665,7 @@ paths: application/json: schema: type: array - items: &378 + items: &396 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -48129,7 +49812,7 @@ paths: - updated_at - project_url examples: - default: &379 + default: &397 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48172,23 +49855,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *377 - - &826 + - *395 + - &844 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *378 + schema: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -48211,8 +49894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *377 - - *78 + - *395 + - *83 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -48221,18 +49904,21 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 - - *99 - - *100 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - *104 + - *105 - *17 responses: '200': @@ -48241,7 +49927,7 @@ paths: application/json: schema: type: array - items: &385 + items: &403 title: Projects v2 Item description: An item belonging to a project type: object @@ -48257,7 +49943,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &383 + content_type: &401 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -48307,7 +49993,7 @@ paths: - updated_at - archived_at examples: - default: &386 + default: &404 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -49001,8 +50687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *78 - - *377 + - *83 + - *395 requestBody: required: true description: Details of the item to add to the project. @@ -49039,7 +50725,7 @@ paths: description: Response content: application/json: - schema: &827 + schema: &845 title: Projects v2 Item description: An item belonging to a project type: object @@ -49052,8 +50738,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *189 - - &568 + - *206 + - &585 title: Pull Request Simple description: Pull Request Simple type: object @@ -49159,8 +50845,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true active_lock_reason: type: string @@ -49205,7 +50891,7 @@ paths: nullable: true requested_teams: type: array - items: *282 + items: *302 nullable: true head: type: object @@ -49214,7 +50900,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: @@ -49237,7 +50923,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: @@ -49256,7 +50942,7 @@ paths: _links: type: object properties: - comments: &382 + comments: &400 title: Link description: Hypermedia Link type: object @@ -49265,13 +50951,13 @@ paths: type: string required: - href - commits: *382 - statuses: *382 - html: *382 - issue: *382 - review_comments: *382 - review_comment: *382 - self: *382 + commits: *400 + statuses: *400 + html: *400 + issue: *400 + review_comments: *400 + review_comment: *400 + self: *400 required: - comments - commits @@ -49281,8 +50967,8 @@ paths: - review_comments - review_comment - self - author_association: *190 - auto_merge: &679 + author_association: *207 + auto_merge: &698 title: Auto merge description: The status of auto merging a pull request. type: object @@ -49384,7 +51070,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *383 + content_type: *401 creator: *4 created_at: type: string @@ -49417,7 +51103,7 @@ paths: - updated_at - archived_at examples: - issue: &384 + issue: &402 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -49472,7 +51158,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *384 + pull_request: *402 '304': *37 '403': *29 '401': *25 @@ -49492,9 +51178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *377 - - *78 - - &387 + - *395 + - *83 + - &405 name: item_id description: The unique identifier of the project item. in: path @@ -49502,24 +51188,27 @@ paths: schema: type: integer - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *385 + schema: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -49540,9 +51229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *377 - - *78 - - *387 + - *395 + - *83 + - *405 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -49612,13 +51301,13 @@ paths: description: Response content: application/json: - schema: *385 + schema: *403 examples: - text_field: *386 - number_field: *386 - date_field: *386 - single_select_field: *386 - iteration_field: *386 + text_field: *404 + number_field: *404 + date_field: *404 + single_select_field: *404 + iteration_field: *404 '401': *25 '403': *29 '404': *6 @@ -49638,9 +51327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *377 - - *78 - - *387 + - *395 + - *83 + - *405 responses: '204': description: Response @@ -49664,7 +51353,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -49672,9 +51361,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -49701,7 +51390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -49712,7 +51401,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *129 + items: *145 minItems: 1 maxItems: 100 required: @@ -49742,9 +51431,9 @@ paths: application/json: schema: type: array - items: *129 + items: *145 examples: - default: *130 + default: *146 '403': *29 '404': *6 x-github: @@ -49765,16 +51454,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 responses: '200': description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -49797,13 +51486,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 requestBody: required: true content: application/json: - schema: *388 + schema: *406 examples: default: value: @@ -49819,9 +51508,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *145 examples: - default: *132 + default: *147 '403': *29 '404': *6 x-github: @@ -49844,10 +51533,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *78 - - *131 + - *83 + - *141 responses: - '204': *133 + '204': *143 '403': *29 '404': *6 x-github: @@ -49868,7 +51557,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *78 + - *83 - *17 - *19 - name: repository_query @@ -49906,25 +51595,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &389 - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value + items: *144 description: List of custom property names and associated values required: - repository_id @@ -49973,7 +51644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *78 + - *83 requestBody: required: true content: @@ -49993,7 +51664,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *389 + items: *144 required: - repository_names - properties @@ -50034,7 +51705,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *78 + - *83 - *17 - *19 responses: @@ -50046,7 +51717,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -50065,8 +51736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response if user is a public member @@ -50090,8 +51761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -50112,8 +51783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *78 - - *182 + - *83 + - *198 responses: '204': description: Response @@ -50137,7 +51808,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *78 + - *83 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -50184,9 +51855,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -50207,7 +51878,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *78 + - *83 requestBody: required: true content: @@ -50389,7 +52060,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &476 title: Full Repository description: Full Repository type: object @@ -50666,8 +52337,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *390 - required: *391 + properties: *407 + required: *408 nullable: true temp_clone_token: type: string @@ -50754,8 +52425,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true organization: title: Simple User @@ -50764,8 +52435,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *69 - source: *69 + parent: *74 + source: *74 forks: type: integer master_branch: @@ -50782,7 +52453,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &573 + properties: &590 url: type: string format: uri @@ -50798,12 +52469,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &574 + required: &591 - url - key - name - html_url - security_and_analysis: *392 + security_and_analysis: *409 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -50887,7 +52558,7 @@ paths: - network_count - subscribers_count examples: - default: &461 + default: &478 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -51405,7 +53076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response @@ -51413,9 +53084,9 @@ paths: application/json: schema: type: array - items: *393 + items: *410 examples: - default: *394 + default: *411 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -51437,10 +53108,10 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - *17 - *19 - - &702 + - &721 name: targets description: | A comma-separated list of rule targets to filter by. @@ -51458,7 +53129,7 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: default: value: @@ -51505,7 +53176,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 requestBody: description: Request body required: true @@ -51526,40 +53197,40 @@ paths: - push - repository default: branch - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *395 + items: *157 + conditions: *412 rules: type: array description: An array of rules within the ruleset. - items: &397 + items: &414 title: Repository Rule type: object description: A repository rule. oneOf: - - *142 - - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - *158 - *159 - *160 - *161 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - *174 + - *175 + - *176 + - *177 required: - name - enforcement @@ -51597,9 +53268,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: &396 + default: &413 value: id: 21 name: super cool ruleset @@ -51653,8 +53324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *78 - - &704 + - *83 + - &723 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -51664,16 +53335,16 @@ paths: schema: type: string x-multi-segment: true - - *279 - - *96 - - &705 + - *299 + - *101 + - &724 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &706 + - &725 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51693,7 +53364,7 @@ paths: description: Response content: application/json: - schema: &707 + schema: &726 title: Rule Suites description: Response type: array @@ -51748,7 +53419,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &708 + default: &727 value: - id: 21 actor_id: 12 @@ -51791,8 +53462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *78 - - &709 + - *83 + - &728 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51808,7 +53479,7 @@ paths: description: Response content: application/json: - schema: &710 + schema: &729 title: Rule Suite description: Response type: object @@ -51907,7 +53578,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &711 + default: &730 value: id: 21 actor_id: 12 @@ -51968,7 +53639,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -51980,9 +53651,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *396 + default: *413 '404': *6 '500': *40 put: @@ -52000,7 +53671,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52026,16 +53697,16 @@ paths: - tag - push - repository - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *395 + items: *157 + conditions: *412 rules: description: An array of rules within the ruleset. type: array - items: *397 + items: *414 examples: default: value: @@ -52070,9 +53741,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *396 + default: *413 '404': *6 '500': *40 delete: @@ -52090,7 +53761,7 @@ paths: category: orgs subcategory: rules parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52113,7 +53784,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *78 + - *83 - *17 - *19 - name: ruleset_id @@ -52129,9 +53800,9 @@ paths: application/json: schema: type: array - items: *166 + items: *182 examples: - default: *398 + default: *415 '404': *6 '500': *40 x-github: @@ -52150,7 +53821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *78 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -52168,7 +53839,7 @@ paths: description: Response content: application/json: - schema: *399 + schema: *416 examples: default: value: @@ -52230,15 +53901,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *78 - - *400 - - *401 - - *402 - - *403 - - *101 + - *83 + - *417 + - *418 + - *419 + - *420 + - *106 - *19 - *17 - - &713 + - &732 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -52248,7 +53919,7 @@ paths: required: false schema: type: string - - &714 + - &733 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -52258,10 +53929,10 @@ paths: required: false schema: type: string - - *404 - - *405 - - *406 - - *407 + - *421 + - *422 + - *423 + - *424 responses: '200': description: Response @@ -52269,13 +53940,13 @@ paths: application/json: schema: type: array - items: *408 + items: *425 examples: - default: *409 + default: *426 headers: Link: *43 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52300,15 +53971,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *410 + schema: *427 examples: - default: *411 + default: *428 '403': *29 '404': *6 patch: @@ -52329,7 +54000,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *78 + - *83 requestBody: required: true content: @@ -52337,7 +54008,7 @@ paths: schema: type: object properties: - pattern_config_version: *169 + pattern_config_version: *185 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -52363,7 +54034,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *169 + custom_pattern_version: *185 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -52399,7 +54070,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *15 "/orgs/{org}/security-advisories": get: @@ -52417,8 +54088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *78 - - *101 + - *83 + - *106 - name: sort description: The property to sort the results by. in: query @@ -52430,8 +54101,8 @@ paths: - updated - published default: created - - *99 - - *100 + - *104 + - *105 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -52461,7 +54132,7 @@ paths: application/json: schema: type: array - items: &735 + items: &754 description: A repository security advisory. type: object properties: @@ -52648,7 +54319,7 @@ paths: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array nullable: true @@ -52681,7 +54352,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 credits_detailed: type: array nullable: true @@ -52691,7 +54362,7 @@ paths: type: object properties: user: *4 - type: *412 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -52715,14 +54386,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *282 + items: *302 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *110 + - *115 required: - ghsa_id - cve_id @@ -52752,7 +54423,7 @@ paths: - private_fork additionalProperties: false examples: - default: &736 + default: &755 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -53131,7 +54802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *78 + - *83 responses: '200': description: Response @@ -53139,9 +54810,9 @@ paths: application/json: schema: type: array - items: *413 + items: *430 examples: - default: *357 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53164,8 +54835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -53190,8 +54861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -53220,15 +54891,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *414 + schema: *431 examples: - default: *415 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53252,8 +54923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *78 - - *416 + - *83 + - *433 - *17 - *19 responses: @@ -53261,9 +54932,9 @@ paths: description: Success content: application/json: - schema: *417 + schema: *434 examples: - default: *418 + default: *435 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -53285,15 +54956,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53315,15 +54986,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *421 + schema: *438 examples: - default: *422 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53343,7 +55014,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *78 + - *83 responses: '200': description: Immutable releases settings response @@ -53392,7 +55063,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *78 + - *83 responses: '204': description: Response @@ -53449,7 +55120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *78 + - *83 - *19 - *17 responses: @@ -53467,9 +55138,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *269 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53488,7 +55159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *78 + - *83 requestBody: required: true content: @@ -53537,8 +55208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -53560,8 +55231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *78 - - *249 + - *83 + - *269 responses: '204': description: Response @@ -53584,7 +55255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *78 + - *83 - *17 - *19 responses: @@ -53602,9 +55273,9 @@ paths: type: integer network_configurations: type: array - items: *126 + items: *136 examples: - default: *423 + default: *440 headers: Link: *43 x-github: @@ -53625,7 +55296,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 + - *83 requestBody: required: true content: @@ -53667,9 +55338,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53689,16 +55360,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 - - *128 + - *83 + - *138 responses: '200': description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 headers: Link: *43 x-github: @@ -53719,8 +55390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *78 - - *128 + - *83 + - *138 requestBody: required: true content: @@ -53759,9 +55430,9 @@ paths: description: Response content: application/json: - schema: *126 + schema: *136 examples: - default: *127 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53780,8 +55451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *78 - - *128 + - *83 + - *138 responses: '204': description: Response @@ -53804,16 +55475,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *78 - - *424 + - *83 + - *441 responses: '200': description: Response content: application/json: - schema: *425 + schema: *442 examples: - default: *426 + default: *443 headers: Link: *43 x-github: @@ -53832,7 +55503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *78 + - *83 - *17 - name: page description: Page token @@ -53851,7 +55522,7 @@ paths: description: Response content: application/json: - schema: &448 + schema: &465 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -53897,7 +55568,7 @@ paths: type: string nullable: true examples: - default: &449 + default: &466 value: groups: - group_id: '123' @@ -53942,8 +55613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -53975,13 +55646,13 @@ paths: application/json: schema: type: array - items: *175 + items: *191 examples: - default: *176 + default: *192 '500': *40 '403': *29 '404': *6 - '422': *177 + '422': *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53999,7 +55670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *78 + - *83 - *17 - *19 responses: @@ -54009,9 +55680,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 headers: Link: *43 '403': *29 @@ -54033,7 +55704,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *78 + - *83 requestBody: required: true content: @@ -54105,7 +55776,7 @@ paths: description: Response content: application/json: - schema: &427 + schema: &444 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -54168,8 +55839,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *355 - required: *356 + properties: *373 + required: *374 nullable: true members_count: type: integer @@ -54432,7 +56103,7 @@ paths: - repos_count - organization examples: - default: &428 + default: &445 value: id: 1 node_id: MDQ6VGVhbTE= @@ -54502,16 +56173,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 x-github: githubCloudOnly: false @@ -54532,8 +56203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: false content: @@ -54595,16 +56266,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '201': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 '422': *15 '403': *29 @@ -54629,8 +56300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -54656,9 +56327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *78 - - *184 - - *101 + - *83 + - *201 + - *106 - *17 - *19 - name: pinned @@ -54674,7 +56345,7 @@ paths: application/json: schema: type: array - items: &429 + items: &446 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -54753,7 +56424,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *191 + reactions: *208 required: - author - body @@ -54773,7 +56444,7 @@ paths: - updated_at - url examples: - default: &779 + default: &798 value: - author: login: octocat @@ -54847,8 +56518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -54882,9 +56553,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: &430 + default: &447 value: author: login: octocat @@ -54956,9 +56627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *78 - - *184 - - &431 + - *83 + - *201 + - &448 name: discussion_number description: The number that identifies the discussion. in: path @@ -54970,9 +56641,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54994,9 +56665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: false content: @@ -55019,9 +56690,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: &780 + default: &799 value: author: login: octocat @@ -55091,9 +56762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 responses: '204': description: Response @@ -55119,10 +56790,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *78 - - *184 - - *431 - - *101 + - *83 + - *201 + - *448 + - *106 - *17 - *19 responses: @@ -55132,7 +56803,7 @@ paths: application/json: schema: type: array - items: &432 + items: &449 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -55189,7 +56860,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *191 + reactions: *208 required: - author - body @@ -55204,7 +56875,7 @@ paths: - updated_at - url examples: - default: &781 + default: &800 value: - author: login: octocat @@ -55272,9 +56943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: true content: @@ -55296,9 +56967,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: &433 + default: &450 value: author: login: octocat @@ -55364,10 +57035,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - &434 + - *83 + - *201 + - *448 + - &451 name: comment_number description: The number that identifies the comment. in: path @@ -55379,9 +57050,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55403,10 +57074,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 requestBody: required: true content: @@ -55428,9 +57099,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: &782 + default: &801 value: author: login: octocat @@ -55494,10 +57165,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 responses: '204': description: Response @@ -55523,10 +57194,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -55552,7 +57223,7 @@ paths: application/json: schema: type: array - items: &435 + items: &452 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -55595,7 +57266,7 @@ paths: - content - created_at examples: - default: &437 + default: &454 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -55645,10 +57316,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *78 - - *184 - - *431 - - *434 + - *83 + - *201 + - *448 + - *451 requestBody: required: true content: @@ -55681,9 +57352,9 @@ paths: team discussion comment content: application/json: - schema: *435 + schema: *452 examples: - default: &436 + default: &453 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -55712,9 +57383,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55737,11 +57408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *78 - - *184 - - *431 - - *434 - - &438 + - *83 + - *201 + - *448 + - *451 + - &455 name: reaction_id description: The unique identifier of the reaction. in: path @@ -55773,9 +57444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -55801,9 +57472,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -55829,9 +57500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *78 - - *184 - - *431 + - *83 + - *201 + - *448 requestBody: required: true content: @@ -55863,16 +57534,16 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55895,10 +57566,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *78 - - *184 - - *431 - - *438 + - *83 + - *201 + - *448 + - *455 responses: '204': description: Response @@ -55921,16 +57592,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *439 + schema: *456 examples: - default: *440 + default: *457 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55949,8 +57620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -55973,9 +57644,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *458 examples: - default: *442 + default: *459 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -55994,8 +57665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '204': description: Response @@ -56019,8 +57690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56030,9 +57701,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 x-github: @@ -56054,8 +57725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *78 - - *184 + - *83 + - *201 - name: role description: Filters members returned by their role in the team. in: query @@ -56078,7 +57749,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -56108,15 +57779,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 responses: '200': description: Response content: application/json: - schema: &443 + schema: &460 title: Team Membership description: Team Membership type: object @@ -56143,7 +57814,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &783 + response-if-user-is-a-team-maintainer: &802 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56179,9 +57850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 requestBody: required: false content: @@ -56206,9 +57877,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-users-membership-with-team-is-now-pending: &784 + response-if-users-membership-with-team-is-now-pending: &803 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56243,9 +57914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *78 - - *184 - - *182 + - *83 + - *201 + - *198 responses: '204': description: Response @@ -56270,8 +57941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56281,7 +57952,7 @@ paths: application/json: schema: type: array - items: &444 + items: &461 title: Team Project description: A team's access to a project. type: object @@ -56349,7 +58020,7 @@ paths: - updated_at - permissions examples: - default: &785 + default: &804 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -56412,9 +58083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *78 - - *184 - - &445 + - *83 + - *201 + - &462 name: project_id description: The unique identifier of the project. in: path @@ -56426,9 +58097,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *461 examples: - default: &786 + default: &805 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -56490,9 +58161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *78 - - *184 - - *445 + - *83 + - *201 + - *462 requestBody: required: false content: @@ -56558,9 +58229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *78 - - *184 - - *445 + - *83 + - *201 + - *462 responses: '204': description: Response @@ -56587,8 +58258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -56598,9 +58269,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -56629,16 +58300,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &787 + schema: &806 title: Team Repository description: A team's access to a repository. type: object @@ -56661,8 +58332,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true forks: type: integer @@ -57207,10 +58878,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 requestBody: required: false content: @@ -57255,10 +58926,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *78 - - *184 - - *446 - - *447 + - *83 + - *201 + - *463 + - *464 responses: '204': description: Response @@ -57284,16 +58955,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *78 - - *184 + - *83 + - *201 responses: '200': description: Response content: application/json: - schema: *448 + schema: *465 examples: - default: *449 + default: *466 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57315,8 +58986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *78 - - *184 + - *83 + - *201 requestBody: required: true content: @@ -57359,7 +59030,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *465 examples: default: value: @@ -57391,8 +59062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *78 - - *184 + - *83 + - *201 - *17 - *19 responses: @@ -57402,9 +59073,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - response-if-child-teams-exist: &788 + response-if-child-teams-exist: &807 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -57457,7 +59128,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *78 + - *83 - name: security_product in: path description: The security feature to enable or disable. @@ -57531,7 +59202,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &450 + - &467 name: card_id description: The unique identifier of the card. in: path @@ -57543,7 +59214,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &468 title: Project Card description: Project cards represent a scope of work. type: object @@ -57610,7 +59281,7 @@ paths: - created_at - updated_at examples: - default: &452 + default: &469 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -57666,7 +59337,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *450 + - *467 requestBody: required: false content: @@ -57693,9 +59364,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 '304': *37 '403': *29 '401': *25 @@ -57722,7 +59393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *450 + - *467 responses: '204': description: Response @@ -57766,7 +59437,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *450 + - *467 requestBody: required: true content: @@ -57877,7 +59548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &453 + - &470 name: column_id description: The unique identifier of the column. in: path @@ -57889,7 +59560,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &471 title: Project Column description: Project columns contain cards of work. type: object @@ -57935,7 +59606,7 @@ paths: - created_at - updated_at examples: - default: &455 + default: &472 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -57970,7 +59641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *453 + - *470 requestBody: required: true content: @@ -57994,9 +59665,9 @@ paths: description: Response content: application/json: - schema: *454 + schema: *471 examples: - default: *455 + default: *472 '304': *37 '403': *29 '401': *25 @@ -58021,7 +59692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *453 + - *470 responses: '204': description: Response @@ -58050,7 +59721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *453 + - *470 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -58071,7 +59742,7 @@ paths: application/json: schema: type: array - items: *451 + items: *468 examples: default: value: @@ -58130,7 +59801,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *453 + - *470 requestBody: required: true content: @@ -58170,9 +59841,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 '304': *37 '403': *29 '401': *25 @@ -58182,8 +59853,8 @@ paths: application/json: schema: oneOf: - - *232 - - *233 + - *250 + - *251 '503': description: Response content: @@ -58228,7 +59899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *453 + - *470 requestBody: required: true content: @@ -58288,15 +59959,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *445 + - *462 responses: '200': description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: &456 + default: &473 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -58353,7 +60024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *445 + - *462 requestBody: required: false content: @@ -58399,9 +60070,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: *456 + default: *473 '404': description: Not Found if the authenticated user does not have access to the project @@ -58422,7 +60093,7 @@ paths: items: type: string '401': *25 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -58445,7 +60116,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *445 + - *462 responses: '204': description: Delete Success @@ -58466,7 +60137,7 @@ paths: items: type: string '401': *25 - '410': *457 + '410': *474 '404': *6 x-github: githubCloudOnly: false @@ -58490,7 +60161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *445 + - *462 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -58517,7 +60188,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -58547,8 +60218,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *445 - - *182 + - *462 + - *198 requestBody: required: false content: @@ -58600,8 +60271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *445 - - *182 + - *462 + - *198 responses: '204': description: Response @@ -58632,8 +60303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *445 - - *182 + - *462 + - *198 responses: '200': description: Response @@ -58706,7 +60377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *445 + - *462 - *17 - *19 responses: @@ -58716,7 +60387,7 @@ paths: application/json: schema: type: array - items: *454 + items: *471 examples: default: value: @@ -58754,7 +60425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *445 + - *462 requestBody: required: true content: @@ -58777,7 +60448,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *471 examples: default: value: @@ -58842,7 +60513,7 @@ paths: resources: type: object properties: - core: &458 + core: &475 title: Rate Limit type: object properties: @@ -58859,21 +60530,21 @@ paths: - remaining - reset - used - graphql: *458 - search: *458 - code_search: *458 - source_import: *458 - integration_manifest: *458 - code_scanning_upload: *458 - actions_runner_registration: *458 - scim: *458 - dependency_snapshots: *458 - dependency_sbom: *458 - code_scanning_autofix: *458 + graphql: *475 + search: *475 + code_search: *475 + source_import: *475 + integration_manifest: *475 + code_scanning_upload: *475 + actions_runner_registration: *475 + scim: *475 + dependency_snapshots: *475 + dependency_sbom: *475 + code_scanning_autofix: *475 required: - core - search - rate: *458 + rate: *475 required: - rate - resources @@ -58978,14 +60649,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: default-response: summary: Default response @@ -59490,7 +61161,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *460 + '301': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59508,8 +61179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -59766,10 +61437,10 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 - '307': &462 + default: *478 + '307': &479 description: Temporary Redirect content: application/json: @@ -59798,8 +61469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -59821,9 +61492,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *462 + '307': *479 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59845,11 +61516,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - - &477 + - &494 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -59872,7 +61543,7 @@ paths: type: integer artifacts: type: array - items: &463 + items: &480 title: Artifact description: An artifact type: object @@ -59950,7 +61621,7 @@ paths: - expires_at - updated_at examples: - default: &478 + default: &495 value: total_count: 2 artifacts: @@ -60011,9 +61682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *446 - - *447 - - &464 + - *463 + - *464 + - &481 name: artifact_id description: The unique identifier of the artifact. in: path @@ -60025,7 +61696,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *480 examples: default: value: @@ -60063,9 +61734,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *446 - - *447 + - *463 - *464 + - *481 responses: '204': description: Response @@ -60089,9 +61760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *446 - - *447 + - *463 - *464 + - *481 - name: archive_format in: path required: true @@ -60105,7 +61776,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60128,14 +61799,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *465 + schema: *482 examples: default: value: @@ -60161,11 +61832,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - - &466 + - &483 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -60193,13 +61864,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *101 + - *106 responses: '200': description: Response content: application/json: - schema: &467 + schema: &484 title: Repository actions caches description: Repository actions caches type: object @@ -60241,7 +61912,7 @@ paths: - total_count - actions_caches examples: - default: &468 + default: &485 value: total_count: 1 actions_caches: @@ -60273,23 +61944,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *446 - - *447 + - *463 + - *464 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *466 + - *483 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: *468 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60309,8 +61980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *446 - - *447 + - *463 + - *464 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -60341,9 +62012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *446 - - *447 - - &469 + - *463 + - *464 + - &486 name: job_id description: The unique identifier of the job. in: path @@ -60355,7 +62026,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &498 title: Job description: Information of a job execution in a workflow run type: object @@ -60662,9 +62333,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *446 - - *447 - - *469 + - *463 + - *464 + - *486 responses: '302': description: Response @@ -60692,9 +62363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *446 - - *447 - - *469 + - *463 + - *464 + - *486 requestBody: required: false content: @@ -60715,7 +62386,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -60739,8 +62410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Status response @@ -60790,8 +62461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -60825,7 +62496,7 @@ paths: description: Empty response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -60854,8 +62525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -60873,7 +62544,7 @@ paths: type: integer secrets: type: array - items: &483 + items: &500 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -60893,7 +62564,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &501 value: total_count: 2 secrets: @@ -60926,9 +62597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *446 - - *447 - - *470 + - *463 + - *464 + - *487 - *19 responses: '200': @@ -60945,7 +62616,7 @@ paths: type: integer variables: type: array - items: &487 + items: &504 title: Actions Variable type: object properties: @@ -60975,7 +62646,7 @@ paths: - created_at - updated_at examples: - default: &488 + default: &505 value: total_count: 2 variables: @@ -61008,8 +62679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -61018,12 +62689,12 @@ paths: schema: type: object properties: - enabled: &471 + enabled: &488 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *51 - selected_actions_url: *242 - sha_pinning_required: *52 + allowed_actions: *56 + selected_actions_url: *262 + sha_pinning_required: *57 required: - enabled examples: @@ -61053,8 +62724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61065,9 +62736,9 @@ paths: schema: type: object properties: - enabled: *471 - allowed_actions: *51 - sha_pinning_required: *52 + enabled: *488 + allowed_actions: *56 + sha_pinning_required: *57 required: - enabled examples: @@ -61098,14 +62769,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &472 + schema: &489 type: object properties: access_level: @@ -61123,7 +62794,7 @@ paths: required: - access_level examples: - default: &473 + default: &490 value: access_level: organization x-github: @@ -61148,15 +62819,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *472 + schema: *489 examples: - default: *473 + default: *490 responses: '204': description: Response @@ -61180,14 +62851,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: default: value: @@ -61211,8 +62882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Empty response for successful settings update @@ -61222,7 +62893,7 @@ paths: required: true content: application/json: - schema: *245 + schema: *265 examples: default: summary: Set retention days @@ -61246,16 +62917,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *53 + schema: *58 examples: - default: *246 + default: *266 '404': *6 x-github: enabledForGitHubApps: true @@ -61274,8 +62945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61285,7 +62956,7 @@ paths: required: true content: application/json: - schema: *53 + schema: *58 examples: default: summary: Set approval policy to first time contributors @@ -61309,16 +62980,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *247 + schema: *267 examples: - default: *54 + default: *59 '403': *29 '404': *6 x-github: @@ -61338,15 +63009,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *248 + schema: *268 examples: - default: *54 + default: *59 responses: '204': description: Empty response for successful settings update @@ -61370,16 +63041,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *56 + schema: *61 examples: - default: *57 + default: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61402,8 +63073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -61411,9 +63082,9 @@ paths: required: false content: application/json: - schema: *56 + schema: *61 examples: - selected_actions: *57 + selected_actions: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61435,16 +63106,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *251 + schema: *271 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61465,8 +63136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Success response @@ -61477,9 +63148,9 @@ paths: required: true content: application/json: - schema: *252 + schema: *272 examples: - default: *60 + default: *65 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61506,8 +63177,8 @@ paths: in: query schema: type: string - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -61525,9 +63196,9 @@ paths: type: integer runners: type: array - items: *67 + items: *72 examples: - default: *68 + default: *73 headers: Link: *43 x-github: @@ -61551,8 +63222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -61560,9 +63231,9 @@ paths: application/json: schema: type: array - items: *256 + items: *276 examples: - default: *257 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61584,8 +63255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -61628,10 +63299,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *278 '404': *6 '422': *7 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61659,16 +63330,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *259 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61696,16 +63367,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response content: application/json: - schema: *70 + schema: *75 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61727,17 +63398,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: '200': description: Response content: application/json: - schema: *67 + schema: *72 examples: - default: *261 + default: *281 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61758,9 +63429,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: '204': description: Response @@ -61786,11 +63457,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: - '200': *72 + '200': *77 '404': *6 x-github: githubCloudOnly: false @@ -61812,9 +63483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 requestBody: required: true content: @@ -61838,7 +63509,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61862,9 +63533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 requestBody: required: true content: @@ -61889,7 +63560,7 @@ paths: - gpu - accelerated responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61913,11 +63584,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 + - *463 + - *464 + - *71 responses: - '200': *262 + '200': *282 '404': *6 x-github: githubCloudOnly: false @@ -61944,12 +63615,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *446 - - *447 - - *66 - - *263 + - *463 + - *464 + - *71 + - *283 responses: - '200': *72 + '200': *77 '404': *6 '422': *7 x-github: @@ -61975,9 +63646,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *446 - - *447 - - &491 + - *463 + - *464 + - &508 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -61985,7 +63656,7 @@ paths: required: false schema: type: string - - &492 + - &509 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -61993,7 +63664,7 @@ paths: required: false schema: type: string - - &493 + - &510 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -62002,7 +63673,7 @@ paths: required: false schema: type: string - - &494 + - &511 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -62029,7 +63700,7 @@ paths: - pending - *17 - *19 - - &495 + - &512 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -62038,7 +63709,7 @@ paths: schema: type: string format: date-time - - &474 + - &491 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -62047,13 +63718,13 @@ paths: schema: type: boolean default: false - - &496 + - &513 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &497 + - &514 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -62076,7 +63747,7 @@ paths: type: integer workflow_runs: type: array - items: &475 + items: &492 title: Workflow Run description: An invocation of a workflow type: object @@ -62171,7 +63842,7 @@ paths: that triggered the run. type: array nullable: true - items: *194 + items: *211 created_at: type: string format: date-time @@ -62224,7 +63895,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &519 + properties: &536 id: type: string description: SHA for the commit @@ -62275,7 +63946,7 @@ paths: - name - email nullable: true - required: &520 + required: &537 - id - tree_id - message @@ -62283,8 +63954,8 @@ paths: - author - committer nullable: true - repository: *255 - head_repository: *255 + repository: *275 + head_repository: *275 head_repository_id: type: integer example: 5 @@ -62322,7 +63993,7 @@ paths: - workflow_url - pull_requests examples: - default: &498 + default: &515 value: total_count: 1 workflow_runs: @@ -62558,24 +64229,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *446 - - *447 - - &476 + - *463 + - *464 + - &493 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *474 + - *491 responses: '200': description: Response content: application/json: - schema: *475 + schema: *492 examples: - default: &479 + default: &496 value: id: 30433642 name: Build @@ -62816,9 +64487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '204': description: Response @@ -62841,9 +64512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -62962,15 +64633,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -62997,12 +64668,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 - *17 - *19 - - *477 + - *494 responses: '200': description: Response @@ -63018,9 +64689,9 @@ paths: type: integer artifacts: type: array - items: *463 + items: *480 examples: - default: *478 + default: *495 headers: Link: *43 x-github: @@ -63044,25 +64715,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *446 - - *447 - - *476 - - &480 + - *463 + - *464 + - *493 + - &497 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *474 + - *491 responses: '200': description: Response content: application/json: - schema: *475 + schema: *492 examples: - default: *479 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63085,10 +64756,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *446 - - *447 - - *476 - - *480 + - *463 + - *464 + - *493 + - *497 - *17 - *19 responses: @@ -63106,9 +64777,9 @@ paths: type: integer jobs: type: array - items: *481 + items: *498 examples: - default: &482 + default: &499 value: total_count: 1 jobs: @@ -63221,10 +64892,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *446 - - *447 - - *476 - - *480 + - *463 + - *464 + - *493 + - *497 responses: '302': description: Response @@ -63252,19 +64923,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '202': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63287,9 +64958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: true content: @@ -63356,19 +65027,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '202': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63391,9 +65062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -63423,9 +65094,9 @@ paths: type: integer jobs: type: array - items: *481 + items: *498 examples: - default: *482 + default: *499 headers: Link: *43 x-github: @@ -63450,9 +65121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '302': description: Response @@ -63479,9 +65150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '204': description: Response @@ -63508,9 +65179,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -63570,7 +65241,7 @@ paths: items: type: object properties: - type: &604 + type: &621 type: string description: The type of reviewer. enum: @@ -63580,7 +65251,7 @@ paths: reviewer: anyOf: - *4 - - *282 + - *302 required: - environment - wait_timer @@ -63655,9 +65326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: true content: @@ -63704,7 +65375,7 @@ paths: application/json: schema: type: array - items: &590 + items: &607 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -63792,8 +65463,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -63810,7 +65481,7 @@ paths: - created_at - updated_at examples: - default: &591 + default: &608 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -63866,9 +65537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: false content: @@ -63889,7 +65560,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -63912,9 +65583,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 requestBody: required: false content: @@ -63935,7 +65606,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -63968,9 +65639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *446 - - *447 - - *476 + - *463 + - *464 + - *493 responses: '200': description: Response @@ -64107,8 +65778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -64126,9 +65797,9 @@ paths: type: integer secrets: type: array - items: *483 + items: *500 examples: - default: *484 + default: *501 headers: Link: *43 x-github: @@ -64153,16 +65824,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *485 + schema: *502 examples: - default: *486 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64184,17 +65855,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *500 examples: - default: &617 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -64220,9 +65891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -64253,7 +65924,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -64279,9 +65950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -64306,9 +65977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *446 - - *447 - - *470 + - *463 + - *464 + - *487 - *19 responses: '200': @@ -64325,9 +65996,9 @@ paths: type: integer variables: type: array - items: *487 + items: *504 examples: - default: *488 + default: *505 headers: Link: *43 x-github: @@ -64350,8 +66021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -64378,7 +66049,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -64403,17 +66074,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 responses: '200': description: Response content: application/json: - schema: *487 + schema: *504 examples: - default: &618 + default: &635 value: name: USERNAME value: octocat @@ -64439,9 +66110,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 requestBody: required: true content: @@ -64483,9 +66154,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *446 - - *447 - - *268 + - *463 + - *464 + - *288 responses: '204': description: Response @@ -64510,8 +66181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -64529,7 +66200,7 @@ paths: type: integer workflows: type: array - items: &489 + items: &506 title: Workflow description: A GitHub Actions workflow type: object @@ -64636,9 +66307,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *446 - - *447 - - &490 + - *463 + - *464 + - &507 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -64653,7 +66324,7 @@ paths: description: Response content: application/json: - schema: *489 + schema: *506 examples: default: value: @@ -64686,9 +66357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64713,9 +66384,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64766,9 +66437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '204': description: Response @@ -64795,19 +66466,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *446 - - *447 - - *490 - - *491 - - *492 - - *493 - - *494 + - *463 + - *464 + - *507 + - *508 + - *509 + - *510 + - *511 - *17 - *19 - - *495 - - *474 - - *496 - - *497 + - *512 + - *491 + - *513 + - *514 responses: '200': description: Response @@ -64823,9 +66494,9 @@ paths: type: integer workflow_runs: type: array - items: *475 + items: *492 examples: - default: *498 + default: *515 headers: Link: *43 x-github: @@ -64858,9 +66529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *446 - - *447 - - *490 + - *463 + - *464 + - *507 responses: '200': description: Response @@ -64921,12 +66592,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *446 - - *447 - - *101 + - *463 + - *464 + - *106 - *17 - - *99 - - *100 + - *104 + - *105 - name: ref description: |- The Git reference for the activities you want to list. @@ -65086,8 +66757,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -65099,7 +66770,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -65124,8 +66795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *446 - - *447 + - *463 + - *464 - name: assignee in: path required: true @@ -65161,8 +66832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -65274,11 +66945,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *446 - - *447 + - *463 + - *464 - *17 - - *99 - - *100 + - *104 + - *105 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -65331,7 +67002,7 @@ paths: initiator: type: string examples: - default: *499 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65351,8 +67022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -65360,7 +67031,7 @@ paths: application/json: schema: type: array - items: &500 + items: &517 title: Autolink reference description: An autolink reference. type: object @@ -65414,8 +67085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -65454,9 +67125,9 @@ paths: description: response content: application/json: - schema: *500 + schema: *517 examples: - default: &501 + default: &518 value: id: 1 key_prefix: TICKET- @@ -65487,9 +67158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *446 - - *447 - - &502 + - *463 + - *464 + - &519 name: autolink_id description: The unique identifier of the autolink. in: path @@ -65501,9 +67172,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: *501 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -65523,9 +67194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *446 - - *447 - - *502 + - *463 + - *464 + - *519 responses: '204': description: Response @@ -65549,8 +67220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response if Dependabot is enabled @@ -65598,8 +67269,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -65620,8 +67291,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -65641,8 +67312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *446 - - *447 + - *463 + - *464 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -65680,7 +67351,7 @@ paths: - url protected: type: boolean - protection: &504 + protection: &521 title: Branch Protection description: Branch Protection type: object @@ -65722,7 +67393,7 @@ paths: required: - contexts - checks - enforce_admins: &507 + enforce_admins: &524 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -65737,7 +67408,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &509 + required_pull_request_reviews: &526 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -65758,7 +67429,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *282 + items: *302 apps: description: The list of apps with review dismissal access. @@ -65787,7 +67458,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *282 + items: *302 apps: description: The list of apps allowed to bypass pull request requirements. @@ -65813,7 +67484,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &506 + restrictions: &523 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -65876,7 +67547,7 @@ paths: type: string teams: type: array - items: *282 + items: *302 apps: type: array items: @@ -66090,9 +67761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *446 - - *447 - - &505 + - *463 + - *464 + - &522 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -66106,14 +67777,14 @@ paths: description: Response content: application/json: - schema: &515 + schema: &532 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &564 + commit: &581 title: Commit description: Commit type: object @@ -66147,7 +67818,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &503 + properties: &520 name: type: string example: '"Chris Wanstrath"' @@ -66162,7 +67833,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true message: type: string @@ -66183,7 +67854,7 @@ paths: required: - sha - url - verification: &624 + verification: &641 title: Verification type: object properties: @@ -66217,12 +67888,12 @@ paths: nullable: true oneOf: - *4 - - *266 + - *286 committer: nullable: true oneOf: - *4 - - *266 + - *286 parents: type: array items: @@ -66253,7 +67924,7 @@ paths: type: integer files: type: array - items: &577 + items: &594 title: Diff Entry description: Diff Entry type: object @@ -66337,7 +68008,7 @@ paths: - self protected: type: boolean - protection: *504 + protection: *521 protection_url: type: string format: uri @@ -66444,7 +68115,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *460 + '301': *477 '404': *6 x-github: githubCloudOnly: false @@ -66466,15 +68137,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *504 + schema: *521 examples: default: value: @@ -66668,9 +68339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -66925,7 +68596,7 @@ paths: url: type: string format: uri - required_status_checks: &512 + required_status_checks: &529 title: Status Check Policy description: Status Check Policy type: object @@ -67001,7 +68672,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 apps: type: array items: *5 @@ -67019,7 +68690,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 apps: type: array items: *5 @@ -67077,7 +68748,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *506 + restrictions: *523 required_conversation_resolution: type: object properties: @@ -67189,9 +68860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67216,17 +68887,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: &508 + default: &525 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -67248,17 +68919,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: *508 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67277,9 +68948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67304,17 +68975,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *509 + schema: *526 examples: - default: &510 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -67410,9 +69081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67510,9 +69181,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *526 examples: - default: *510 + default: *527 '422': *15 x-github: githubCloudOnly: false @@ -67533,9 +69204,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67562,17 +69233,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: &511 + default: &528 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -67595,17 +69266,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *507 + schema: *524 examples: - default: *511 + default: *528 '404': *6 x-github: githubCloudOnly: false @@ -67625,9 +69296,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67652,17 +69323,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *512 + schema: *529 examples: - default: &513 + default: &530 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -67688,9 +69359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67742,9 +69413,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *529 examples: - default: *513 + default: *530 '404': *6 '422': *15 x-github: @@ -67766,9 +69437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -67792,9 +69463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -67828,9 +69499,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67897,9 +69568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -67963,9 +69634,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: content: application/json: @@ -68031,15 +69702,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response content: application/json: - schema: *506 + schema: *523 examples: default: value: @@ -68130,9 +69801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '204': description: Response @@ -68155,9 +69826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68167,7 +69838,7 @@ paths: type: array items: *5 examples: - default: &514 + default: &531 value: - id: 1 slug: octoapp @@ -68224,9 +69895,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68260,7 +69931,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68281,9 +69952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68317,7 +69988,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68338,9 +70009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68374,7 +70045,7 @@ paths: type: array items: *5 examples: - default: *514 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68396,9 +70067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68406,9 +70077,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '404': *6 x-github: githubCloudOnly: false @@ -68428,9 +70099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -68466,9 +70137,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68489,9 +70160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: false content: @@ -68527,9 +70198,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68550,9 +70221,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: content: application/json: @@ -68587,9 +70258,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 '422': *15 x-github: githubCloudOnly: false @@ -68611,9 +70282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 responses: '200': description: Response @@ -68623,7 +70294,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '404': *6 x-github: githubCloudOnly: false @@ -68647,9 +70318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68682,7 +70353,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68707,9 +70378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68742,7 +70413,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68767,9 +70438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68802,7 +70473,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -68829,9 +70500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 requestBody: required: true content: @@ -68853,7 +70524,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *532 examples: default: value: @@ -68967,12 +70638,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *97 + - *463 + - *464 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -68982,9 +70653,9 @@ paths: application/json: schema: type: array - items: *277 + items: *297 examples: - default: *278 + default: *298 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -69004,8 +70675,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69019,7 +70690,7 @@ paths: description: Response content: application/json: - schema: *277 + schema: *297 examples: default: value: @@ -69078,12 +70749,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *97 + - *463 + - *464 + - *99 + - *100 + - *101 + - *102 - *17 - *19 responses: @@ -69093,9 +70764,9 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 '404': *6 '403': *29 '500': *40 @@ -69119,8 +70790,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69132,7 +70803,7 @@ paths: description: A single bypass request. content: application/json: - schema: *280 + schema: *300 examples: default: value: @@ -69190,8 +70861,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_request_number in: path required: true @@ -69262,8 +70933,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *446 - - *447 + - *463 + - *464 - name: bypass_response_id in: path required: true @@ -69296,8 +70967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -69576,7 +71247,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &533 title: CheckRun description: A check performed on the code of a given code change type: object @@ -69687,16 +71358,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *194 - deployment: &843 + items: *211 + deployment: &861 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -69763,8 +71434,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -69976,9 +71647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *446 - - *447 - - &517 + - *463 + - *464 + - &534 name: check_run_id description: The unique identifier of the check run. in: path @@ -69990,9 +71661,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *533 examples: - default: &518 + default: &535 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -70092,9 +71763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 requestBody: required: true content: @@ -70334,9 +72005,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *533 examples: - default: *518 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70356,9 +72027,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 - *17 - *19 responses: @@ -70453,15 +72124,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *446 - - *447 - - *517 + - *463 + - *464 + - *534 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -70499,8 +72170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -70522,7 +72193,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &521 + schema: &538 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -70586,7 +72257,7 @@ paths: nullable: true pull_requests: type: array - items: *194 + items: *211 nullable: true app: title: GitHub app @@ -70597,9 +72268,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - repository: *255 + properties: *203 + required: *204 + repository: *275 created_at: type: string format: date-time @@ -70608,12 +72279,12 @@ paths: type: string format: date-time nullable: true - head_commit: &869 + head_commit: &887 title: Simple Commit description: A commit. type: object - properties: *519 - required: *520 + properties: *536 + required: *537 latest_check_runs_count: type: integer check_runs_url: @@ -70641,7 +72312,7 @@ paths: - check_runs_url - pull_requests examples: - default: &522 + default: &539 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -70932,9 +72603,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *521 + schema: *538 examples: - default: *522 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70953,8 +72624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -71015,7 +72686,7 @@ paths: required: - app_id - setting - repository: *255 + repository: *275 examples: default: value: @@ -71263,9 +72934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *446 - - *447 - - &523 + - *463 + - *464 + - &540 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -71277,9 +72948,9 @@ paths: description: Response content: application/json: - schema: *521 + schema: *538 examples: - default: *522 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71302,17 +72973,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *446 - - *447 - - *523 - - &570 + - *463 + - *464 + - *540 + - &587 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &571 + - &588 name: status description: Returns check runs with the specified `status`. in: query @@ -71351,9 +73022,9 @@ paths: type: integer check_runs: type: array - items: *516 + items: *533 examples: - default: &572 + default: &589 value: total_count: 1 check_runs: @@ -71455,15 +73126,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *446 - - *447 - - *523 + - *463 + - *464 + - *540 responses: '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -71490,30 +73161,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *446 - - *447 - - *286 - - *287 + - *463 + - *464 + - *306 + - *307 - *19 - *17 - - &539 + - &556 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *524 - - &540 + schema: *541 + - &557 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *101 - - *99 - - *100 + - *106 + - *104 + - *105 - name: sort description: The property by which to sort the results. in: query @@ -71529,13 +73200,13 @@ paths: be returned. in: query required: false - schema: *288 + schema: *308 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *525 + schema: *542 responses: '200': description: Response @@ -71546,14 +73217,14 @@ paths: items: type: object properties: - number: *113 - created_at: *120 - updated_at: *121 - url: *118 - html_url: *119 - instances_url: *526 - state: *104 - fixed_at: *123 + number: *123 + created_at: *130 + updated_at: *131 + url: *128 + html_url: *129 + instances_url: *543 + state: *109 + fixed_at: *133 dismissed_by: title: Simple User description: A GitHub user. @@ -71561,12 +73232,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *122 - dismissed_reason: *527 - dismissed_comment: *528 - rule: *529 - tool: *530 - most_recent_instance: *531 + dismissed_at: *132 + dismissed_reason: *544 + dismissed_comment: *545 + rule: *546 + tool: *547 + most_recent_instance: *548 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71692,14 +73363,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &532 + '403': &549 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71719,9 +73390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *446 - - *447 - - &533 + - *463 + - *464 + - &550 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -71729,23 +73400,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *113 + schema: *123 responses: '200': description: Response content: application/json: - schema: &534 + schema: &551 type: object properties: - number: *113 - created_at: *120 - updated_at: *121 - url: *118 - html_url: *119 - instances_url: *526 - state: *104 - fixed_at: *123 + number: *123 + created_at: *130 + updated_at: *131 + url: *128 + html_url: *129 + instances_url: *543 + state: *109 + fixed_at: *133 dismissed_by: title: Simple User description: A GitHub user. @@ -71753,9 +73424,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *122 - dismissed_reason: *527 - dismissed_comment: *528 + dismissed_at: *132 + dismissed_reason: *544 + dismissed_comment: *545 rule: type: object properties: @@ -71809,8 +73480,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *530 - most_recent_instance: *531 + tool: *547 + most_recent_instance: *548 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71909,9 +73580,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71929,9 +73600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: true content: @@ -71946,8 +73617,8 @@ paths: enum: - open - dismissed - dismissed_reason: *527 - dismissed_comment: *528 + dismissed_reason: *544 + dismissed_comment: *545 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -71966,7 +73637,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *551 examples: default: value: @@ -72042,14 +73713,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &538 + '403': &555 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72069,15 +73740,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 responses: '200': description: Response content: application/json: - schema: &535 + schema: &552 type: object properties: status: @@ -72103,13 +73774,13 @@ paths: - description - started_at examples: - default: &536 + default: &553 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &537 + '400': &554 description: Bad Request content: application/json: @@ -72120,9 +73791,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72145,29 +73816,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 responses: '200': description: OK content: application/json: - schema: *535 + schema: *552 examples: - default: *536 + default: *553 '202': description: Accepted content: application/json: - schema: *535 + schema: *552 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *537 + '400': *554 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -72177,7 +73848,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72199,9 +73870,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: false content: @@ -72246,12 +73917,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *537 - '403': *538 + '400': *554 + '403': *555 '404': *6 '422': description: Unprocessable Entity - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72271,13 +73942,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 - *19 - *17 - - *539 - - *540 + - *556 + - *557 responses: '200': description: Response @@ -72285,7 +73956,7 @@ paths: application/json: schema: type: array - items: *531 + items: *548 examples: default: value: @@ -72324,9 +73995,9 @@ paths: end_column: 50 classifications: - source - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72358,29 +74029,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *446 - - *447 - - *286 - - *287 + - *463 + - *464 + - *306 + - *307 - *19 - *17 - - *540 + - *557 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *524 + schema: *541 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &543 + schema: &560 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *101 + - *106 - name: sort description: The property by which to sort the results. in: query @@ -72397,23 +74068,23 @@ paths: application/json: schema: type: array - items: &544 + items: &561 type: object properties: - ref: *524 - commit_sha: &552 + ref: *541 + commit_sha: &569 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *541 + analysis_key: *558 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *542 + category: *559 error: type: string example: error reading field xyz @@ -72437,8 +74108,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *543 - tool: *530 + sarif_id: *560 + tool: *547 deletable: type: boolean warning: @@ -72499,9 +74170,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72535,8 +74206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -72549,7 +74220,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: response: summary: application/json response @@ -72603,14 +74274,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *532 + '403': *549 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72690,8 +74361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -72744,9 +74415,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *538 + '403': *555 '404': *6 - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -72766,8 +74437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -72775,7 +74446,7 @@ paths: application/json: schema: type: array - items: &545 + items: &562 title: CodeQL Database description: A CodeQL database. type: object @@ -72886,9 +74557,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72915,8 +74586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: language in: path description: The language of the CodeQL database. @@ -72928,7 +74599,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *562 examples: default: value: @@ -72960,11 +74631,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &579 + '302': &596 description: Found - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72984,8 +74655,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *446 - - *447 + - *463 + - *464 - name: language in: path description: The language of the CodeQL database. @@ -72995,9 +74666,9 @@ paths: responses: '204': description: Response - '403': *538 + '403': *555 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73023,8 +74694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73033,7 +74704,7 @@ paths: type: object additionalProperties: false properties: - language: &546 + language: &563 type: string description: The language targeted by the CodeQL query enum: @@ -73112,7 +74783,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &550 + schema: &567 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -73120,9 +74791,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *110 + controller_repo: *115 actor: *4 - query_language: *546 + query_language: *563 query_pack_url: type: string description: The download url for the query pack. @@ -73169,7 +74840,7 @@ paths: items: type: object properties: - repository: &547 + repository: &564 title: Repository Identifier description: Repository Identifier type: object @@ -73205,7 +74876,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &551 + analysis_status: &568 type: string description: The new status of the CodeQL variant analysis repository task. @@ -73237,7 +74908,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &548 + access_mismatch_repos: &565 type: object properties: repository_count: @@ -73251,7 +74922,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *547 + items: *564 required: - repository_count - repositories @@ -73273,8 +74944,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *548 - over_limit_repos: *548 + no_codeql_db_repos: *565 + over_limit_repos: *565 required: - access_mismatch_repos - not_found_repos @@ -73290,7 +74961,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &549 + value: &566 summary: Default response value: id: 1 @@ -73442,17 +75113,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *549 + value: *566 repository_lists: summary: Response for a successful variant analysis submission - value: *549 + value: *566 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73473,8 +75144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *446 - - *447 + - *463 + - *464 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -73486,11 +75157,11 @@ paths: description: Response content: application/json: - schema: *550 + schema: *567 examples: - default: *549 + default: *566 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73511,7 +75182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *446 + - *463 - name: repo in: path description: The name of the controller repository. @@ -73545,8 +75216,8 @@ paths: schema: type: object properties: - repository: *110 - analysis_status: *551 + repository: *115 + analysis_status: *568 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -73650,7 +75321,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73671,8 +75342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -73757,9 +75428,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *532 + '403': *549 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73778,8 +75449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73846,7 +75517,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -73871,7 +75542,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *538 + '403': *555 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -73885,7 +75556,7 @@ paths: content: application/json: schema: *3 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73942,8 +75613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -73951,7 +75622,7 @@ paths: schema: type: object properties: - commit_sha: *552 + commit_sha: *569 ref: type: string description: |- @@ -74009,7 +75680,7 @@ paths: schema: type: object properties: - id: *543 + id: *560 url: type: string description: The REST API URL for checking the status of the upload. @@ -74023,11 +75694,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *538 + '403': *555 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74046,8 +75717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *446 - - *447 + - *463 + - *464 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -74093,10 +75764,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *532 + '403': *549 '404': description: Not Found if the sarif id does not match any upload - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74118,8 +75789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74143,7 +75814,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *105 + configuration: *110 examples: default: value: @@ -74175,7 +75846,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *133 + '204': *143 '304': *37 '403': *29 '404': *6 @@ -74200,8 +75871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -74321,8 +75992,8 @@ paths: parameters: - *17 - *19 - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74338,7 +76009,7 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: default: value: @@ -74636,8 +76307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -74700,22 +76371,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -74739,8 +76410,8 @@ paths: parameters: - *17 - *19 - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -74804,8 +76475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -74840,14 +76511,14 @@ paths: type: integer machines: type: array - items: &795 + items: &814 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *554 - required: *555 + properties: *571 + required: *572 examples: - default: &796 + default: &815 value: total_count: 2 machines: @@ -74887,8 +76558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -74972,8 +76643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -75018,7 +76689,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,8 +76710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -75058,7 +76729,7 @@ paths: type: integer secrets: type: array - items: &559 + items: &576 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -75078,7 +76749,7 @@ paths: - created_at - updated_at examples: - default: *556 + default: *573 headers: Link: *43 x-github: @@ -75101,16 +76772,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *557 + schema: *574 examples: - default: *558 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75130,17 +76801,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *559 + schema: *576 examples: - default: *560 + default: *577 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,9 +76831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -75190,7 +76861,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -75214,9 +76885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -75244,8 +76915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *446 - - *447 + - *463 + - *464 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -75287,7 +76958,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &561 + properties: &578 login: type: string example: octocat @@ -75380,7 +77051,7 @@ paths: user_view_type: type: string example: public - required: &562 + required: &579 - avatar_url - events_url - followers_url @@ -75454,9 +77125,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '204': description: Response if user is a collaborator @@ -75502,9 +77173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 requestBody: required: false content: @@ -75530,7 +77201,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &637 + schema: &654 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -75541,7 +77212,7 @@ paths: example: 42 type: integer format: int64 - repository: *255 + repository: *275 invitee: title: Simple User description: A GitHub user. @@ -75719,7 +77390,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *232 + schema: *250 '403': *29 x-github: triggersNotification: true @@ -75759,9 +77430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '204': description: No Content when collaborator was removed from the repository. @@ -75792,9 +77463,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *446 - - *447 - - *182 + - *463 + - *464 + - *198 responses: '200': description: if user has admin permissions @@ -75814,8 +77485,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *561 - required: *562 + properties: *578 + required: *579 nullable: true required: - permission @@ -75870,8 +77541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -75881,7 +77552,7 @@ paths: application/json: schema: type: array - items: &563 + items: &580 title: Commit Comment description: Commit Comment type: object @@ -75922,8 +77593,8 @@ paths: updated_at: type: string format: date-time - author_association: *190 - reactions: *191 + author_association: *207 + reactions: *208 required: - url - html_url @@ -75939,7 +77610,7 @@ paths: - created_at - updated_at examples: - default: &566 + default: &583 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75998,17 +77669,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *563 + schema: *580 examples: - default: &567 + default: &584 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76065,9 +77736,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -76089,7 +77760,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -76140,9 +77811,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -76163,9 +77834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -76191,9 +77862,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -76214,9 +77885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -76248,16 +77919,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -76279,10 +77950,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -76331,8 +78002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *446 - - *447 + - *463 + - *464 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -76388,9 +78059,9 @@ paths: application/json: schema: type: array - items: *564 + items: *581 examples: - default: &686 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -76464,7 +78135,7 @@ paths: '500': *40 '400': *14 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76484,9 +78155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *446 - - *447 - - &565 + - *463 + - *464 + - &582 name: commit_sha description: The SHA of the commit. in: path @@ -76533,7 +78204,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76558,9 +78229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 - *17 - *19 responses: @@ -76570,9 +78241,9 @@ paths: application/json: schema: type: array - items: *563 + items: *580 examples: - default: *566 + default: *583 headers: Link: *43 x-github: @@ -76600,9 +78271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 requestBody: required: true content: @@ -76637,9 +78308,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: - default: *567 + default: *584 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76667,9 +78338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 - *17 - *19 responses: @@ -76679,9 +78350,9 @@ paths: application/json: schema: type: array - items: *568 + items: *585 examples: - default: &678 + default: &697 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -77161,7 +78832,7 @@ paths: draft: false headers: Link: *43 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77218,11 +78889,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 - - &569 + - &586 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -77237,9 +78908,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *581 examples: - default: &665 + default: &682 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77326,8 +78997,8 @@ paths: '422': *15 '404': *6 '500': *40 - '503': *167 - '409': *109 + '503': *183 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77352,11 +79023,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *446 - - *447 - - *569 - - *570 - - *571 + - *463 + - *464 + - *586 + - *587 + - *588 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -77390,9 +79061,9 @@ paths: type: integer check_runs: type: array - items: *516 + items: *533 examples: - default: *572 + default: *589 headers: Link: *43 x-github: @@ -77417,9 +79088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -77427,7 +79098,7 @@ paths: schema: type: integer example: 1 - - *570 + - *587 - *17 - *19 responses: @@ -77445,7 +79116,7 @@ paths: type: integer check_suites: type: array - items: *521 + items: *538 examples: default: value: @@ -77645,9 +79316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - *17 - *19 responses: @@ -77714,7 +79385,7 @@ paths: type: string total_count: type: integer - repository: *255 + repository: *275 commit_url: type: string format: uri @@ -77845,9 +79516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *446 - - *447 - - *569 + - *463 + - *464 + - *586 - *17 - *19 responses: @@ -77857,7 +79528,7 @@ paths: application/json: schema: type: array - items: &740 + items: &759 title: Status description: The status of a commit. type: object @@ -77938,7 +79609,7 @@ paths: site_admin: false headers: Link: *43 - '301': *460 + '301': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77966,8 +79637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -77996,20 +79667,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *573 - required: *574 + properties: *590 + required: *591 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &575 + properties: &592 url: type: string format: uri html_url: type: string format: uri - required: &576 + required: &593 - url - html_url nullable: true @@ -78017,32 +79688,32 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true contributing: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true readme: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true issue_template: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true pull_request_template: title: Community Health File type: object - properties: *575 - required: *576 + properties: *592 + required: *593 nullable: true required: - code_of_conduct @@ -78169,8 +79840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 - name: basehead @@ -78213,8 +79884,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *564 - merge_base_commit: *564 + base_commit: *581 + merge_base_commit: *581 status: type: string enum: @@ -78234,10 +79905,10 @@ paths: example: 6 commits: type: array - items: *564 + items: *581 files: type: array - items: *577 + items: *594 required: - url - html_url @@ -78481,7 +80152,7 @@ paths: module Test" '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78523,8 +80194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -78667,7 +80338,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &578 + response-if-content-is-a-file: &595 summary: Response if content is a file value: type: file @@ -78799,7 +80470,7 @@ paths: - size - type - url - - &691 + - &710 title: Content File description: Content File type: object @@ -79000,7 +80671,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *578 + response-if-content-is-a-file: *595 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -79069,7 +80740,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *579 + '302': *596 '304': *37 x-github: githubCloudOnly: false @@ -79092,8 +80763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -79186,7 +80857,7 @@ paths: description: Response content: application/json: - schema: &580 + schema: &597 title: File Commit description: File Commit type: object @@ -79338,7 +81009,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *597 examples: example-for-creating-a-file: value: @@ -79392,7 +81063,7 @@ paths: schema: oneOf: - *3 - - &619 + - &636 description: Repository rule violation was detected type: object properties: @@ -79413,7 +81084,7 @@ paths: items: type: object properties: - placeholder_id: &732 + placeholder_id: &751 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -79445,8 +81116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *446 - - *447 + - *463 + - *464 - name: path description: path parameter in: path @@ -79507,7 +81178,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *597 examples: default: value: @@ -79541,8 +81212,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *109 - '503': *167 + '409': *114 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79562,8 +81233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *446 - - *447 + - *463 + - *464 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -79686,31 +81357,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *446 - - *447 - - *303 - - *304 - - *305 - - *306 + - *463 + - *464 + - *323 + - *324 + - *325 + - *326 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *307 - - *581 - - *308 - - *309 - - *101 - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 + - *327 + - *598 + - *328 + - *329 + - *106 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -79719,10 +81382,8 @@ paths: schema: type: integer default: 30 - - *99 - - *100 - - *310 - - *311 + - *104 + - *105 responses: '200': description: Response @@ -79730,11 +81391,11 @@ paths: application/json: schema: type: array - items: &584 + items: &601 type: object description: A Dependabot alert. properties: - number: *113 + number: *123 state: type: string description: The state of the Dependabot alert. @@ -79749,7 +81410,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *114 + package: *124 manifest_path: type: string description: The full path to the dependency manifest file, @@ -79776,13 +81437,13 @@ paths: - unknown - direct - transitive - security_advisory: *582 - security_vulnerability: *117 - url: *118 - html_url: *119 - created_at: *120 - updated_at: *121 - dismissed_at: *122 + security_advisory: *599 + security_vulnerability: *127 + url: *128 + html_url: *129 + created_at: *130 + updated_at: *131 + dismissed_at: *132 dismissed_by: title: Simple User description: A GitHub user. @@ -79806,8 +81467,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *123 - auto_dismissed_at: *583 + fixed_at: *133 + auto_dismissed_at: *600 required: - number - state @@ -80037,9 +81698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *446 - - *447 - - &585 + - *463 + - *464 + - &602 name: alert_number in: path description: |- @@ -80048,13 +81709,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *113 + schema: *123 responses: '200': description: Response content: application/json: - schema: *584 + schema: *601 examples: default: value: @@ -80167,9 +81828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *446 - - *447 - - *585 + - *463 + - *464 + - *602 requestBody: required: true content: @@ -80214,7 +81875,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: default: value: @@ -80320,7 +81981,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *109 + '409': *114 '422': *7 x-github: githubCloudOnly: false @@ -80343,8 +82004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -80362,7 +82023,7 @@ paths: type: integer secrets: type: array - items: &588 + items: &605 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -80415,16 +82076,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *586 + schema: *603 examples: - default: *587 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80444,15 +82105,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '200': description: Response content: application/json: - schema: *588 + schema: *605 examples: default: value: @@ -80478,9 +82139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 requestBody: required: true content: @@ -80508,7 +82169,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -80532,9 +82193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *446 - - *447 - - *265 + - *463 + - *464 + - *285 responses: '204': description: Response @@ -80556,8 +82217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *446 - - *447 + - *463 + - *464 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -80717,8 +82378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -80957,8 +82618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -81033,7 +82694,7 @@ paths: - version - url additionalProperties: false - metadata: &589 + metadata: &606 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -81066,7 +82727,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *589 + metadata: *606 resolved: type: object description: A collection of resolved package dependencies. @@ -81079,7 +82740,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *589 + metadata: *606 relationship: type: string description: A notation of whether a dependency is requested @@ -81208,8 +82869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *446 - - *447 + - *463 + - *464 - name: sha description: The SHA recorded at creation time. in: query @@ -81249,9 +82910,9 @@ paths: application/json: schema: type: array - items: *590 + items: *607 examples: - default: *591 + default: *608 headers: Link: *43 x-github: @@ -81317,8 +82978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -81399,7 +83060,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *607 examples: simple-example: summary: Simple example @@ -81472,9 +83133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *446 - - *447 - - &592 + - *463 + - *464 + - &609 name: deployment_id description: deployment_id parameter in: path @@ -81486,7 +83147,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *607 examples: default: value: @@ -81551,9 +83212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 responses: '204': description: Response @@ -81575,9 +83236,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 - *17 - *19 responses: @@ -81587,7 +83248,7 @@ paths: application/json: schema: type: array - items: &593 + items: &610 title: Deployment Status description: The status of a deployment. type: object @@ -81678,8 +83339,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -81748,9 +83409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 requestBody: required: true content: @@ -81825,9 +83486,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *610 examples: - default: &594 + default: &611 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -81883,9 +83544,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *446 - - *447 - - *592 + - *463 + - *464 + - *609 - name: status_id in: path required: true @@ -81896,9 +83557,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *610 examples: - default: *594 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -81925,12 +83586,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 - - *595 - - *596 - - *597 - - *598 + - *463 + - *464 + - *612 + - *613 + - *614 + - *615 - *17 - *19 responses: @@ -81940,9 +83601,9 @@ paths: application/json: schema: type: array - items: *599 + items: *616 examples: - default: *600 + default: *617 '404': *6 '403': *29 '500': *40 @@ -81966,8 +83627,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -81979,7 +83640,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *599 + schema: *616 examples: default: value: @@ -82035,8 +83696,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82095,12 +83756,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 - - *94 - - *95 - - *96 - - *601 + - *463 + - *464 + - *99 + - *100 + - *101 + - *618 - *17 - *19 responses: @@ -82110,9 +83771,9 @@ paths: application/json: schema: type: array - items: *602 + items: *619 examples: - default: *603 + default: *620 '404': *6 '403': *29 '500': *40 @@ -82137,8 +83798,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82150,7 +83811,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *602 + schema: *619 examples: default: value: @@ -82208,8 +83869,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: alert_number in: path required: true @@ -82278,8 +83939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -82336,8 +83997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -82354,7 +84015,7 @@ paths: type: integer environments: type: array - items: &605 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -82406,7 +84067,7 @@ paths: type: type: string example: wait_timer - wait_timer: &607 + wait_timer: &624 type: integer example: 30 description: The amount of time to delay a job after @@ -82443,11 +84104,11 @@ paths: items: type: object properties: - type: *604 + type: *621 reviewer: anyOf: - *4 - - *282 + - *302 required: - id - node_id @@ -82467,7 +84128,7 @@ paths: - id - node_id - type - deployment_branch_policy: &608 + deployment_branch_policy: &625 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -82583,9 +84244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *446 - - *447 - - &606 + - *463 + - *464 + - &623 name: environment_name in: path required: true @@ -82598,9 +84259,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *622 examples: - default: &609 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -82684,9 +84345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: false content: @@ -82695,7 +84356,7 @@ paths: type: object nullable: true properties: - wait_timer: *607 + wait_timer: *624 prevent_self_review: type: boolean example: false @@ -82712,13 +84373,13 @@ paths: items: type: object properties: - type: *604 + type: *621 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *608 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -82738,9 +84399,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *622 examples: - default: *609 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -82764,9 +84425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 responses: '204': description: Default response @@ -82791,9 +84452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 - *17 - *19 responses: @@ -82811,7 +84472,7 @@ paths: example: 2 branch_policies: type: array - items: &610 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -82868,9 +84529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: true content: @@ -82916,9 +84577,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - example-wildcard: &611 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -82960,10 +84621,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - &612 + - *463 + - *464 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -82975,9 +84636,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - default: *611 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82996,10 +84657,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - *612 + - *463 + - *464 + - *623 + - *629 requestBody: required: true content: @@ -83027,9 +84688,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *627 examples: - default: *611 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83048,10 +84709,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *446 - - *447 - - *606 - - *612 + - *463 + - *464 + - *623 + - *629 responses: '204': description: Response @@ -83076,9 +84737,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 responses: '200': description: List of deployment protection rules @@ -83094,7 +84755,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &613 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -83113,7 +84774,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &614 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -83212,9 +84873,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 requestBody: content: application/json: @@ -83235,9 +84896,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *613 + schema: *630 examples: - default: &615 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -83272,9 +84933,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *606 - - *447 - - *446 + - *623 + - *464 + - *463 - *19 - *17 responses: @@ -83293,7 +84954,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *614 + items: *631 examples: default: value: @@ -83328,10 +84989,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *446 - - *447 - - *606 - - &616 + - *463 + - *464 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -83343,9 +85004,9 @@ paths: description: Response content: application/json: - schema: *613 + schema: *630 examples: - default: *615 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83366,10 +85027,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *606 - - *447 - - *446 - - *616 + - *623 + - *464 + - *463 + - *633 responses: '204': description: Response @@ -83395,9 +85056,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 - *17 - *19 responses: @@ -83415,9 +85076,9 @@ paths: type: integer secrets: type: array - items: *483 + items: *500 examples: - default: *484 + default: *501 headers: Link: *43 x-github: @@ -83442,17 +85103,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 responses: '200': description: Response content: application/json: - schema: *485 + schema: *502 examples: - default: *486 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83474,18 +85135,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *500 examples: - default: *617 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83507,10 +85168,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 requestBody: required: true content: @@ -83541,7 +85202,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -83567,10 +85228,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *446 - - *447 - - *606 - - *265 + - *463 + - *464 + - *623 + - *285 responses: '204': description: Default response @@ -83595,10 +85256,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *446 - - *447 - - *606 - - *470 + - *463 + - *464 + - *623 + - *487 - *19 responses: '200': @@ -83615,9 +85276,9 @@ paths: type: integer variables: type: array - items: *487 + items: *504 examples: - default: *488 + default: *505 headers: Link: *43 x-github: @@ -83640,9 +85301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *446 - - *447 - - *606 + - *463 + - *464 + - *623 requestBody: required: true content: @@ -83669,7 +85330,7 @@ paths: description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -83694,18 +85355,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *446 - - *447 - - *606 - - *268 + - *463 + - *464 + - *623 + - *288 responses: '200': description: Response content: application/json: - schema: *487 + schema: *504 examples: - default: *618 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83726,10 +85387,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *446 - - *447 - - *268 - - *606 + - *463 + - *464 + - *288 + - *623 requestBody: required: true content: @@ -83771,10 +85432,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *446 - - *447 - - *268 - - *606 + - *463 + - *464 + - *288 + - *623 responses: '204': description: Response @@ -83796,8 +85457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -83807,7 +85468,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: 200-response: value: @@ -83865,8 +85526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *446 - - *447 + - *463 + - *464 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -83888,7 +85549,7 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: default: value: @@ -84025,8 +85686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -84058,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 '400': *14 '422': *15 '403': *29 @@ -84081,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84133,7 +85794,7 @@ paths: schema: type: string '404': *6 - '409': *109 + '409': *114 '403': *29 '422': description: Validation failed @@ -84141,8 +85802,8 @@ paths: application/json: schema: oneOf: - - *232 - - *619 + - *250 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84167,8 +85828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *446 - - *447 + - *463 + - *464 - name: file_sha in: path required: true @@ -84219,7 +85880,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84267,8 +85928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84377,7 +86038,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -84541,7 +86202,7 @@ paths: type: string '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84591,15 +86252,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *446 - - *447 - - *565 + - *463 + - *464 + - *582 responses: '200': description: Response content: application/json: - schema: *620 + schema: *637 examples: default: value: @@ -84630,7 +86291,7 @@ paths: payload: verified_at: '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84655,9 +86316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *446 - - *447 - - &621 + - *463 + - *464 + - &638 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -84674,7 +86335,7 @@ paths: application/json: schema: type: array - items: &622 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -84728,7 +86389,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *43 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84749,17 +86410,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 responses: '200': description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: &623 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -84769,7 +86430,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84788,8 +86449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -84818,16 +86479,16 @@ paths: description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: *623 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84846,9 +86507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 requestBody: required: true content: @@ -84877,11 +86538,11 @@ paths: description: Response content: application/json: - schema: *622 + schema: *639 examples: - default: *623 + default: *640 '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84897,16 +86558,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *446 - - *447 - - *621 + - *463 + - *464 + - *638 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84954,8 +86615,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -85022,7 +86683,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -85073,7 +86734,7 @@ paths: - sha - type - url - verification: *624 + verification: *641 required: - sha - url @@ -85083,7 +86744,7 @@ paths: - tag - message examples: - default: &626 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -85110,7 +86771,7 @@ paths: schema: type: string '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85156,8 +86817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *446 - - *447 + - *463 + - *464 - name: tag_sha in: path required: true @@ -85168,11 +86829,11 @@ paths: description: Response content: application/json: - schema: *625 + schema: *642 examples: - default: *626 + default: *643 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85194,8 +86855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -85268,7 +86929,7 @@ paths: description: Response content: application/json: - schema: &627 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -85341,7 +87002,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85364,8 +87025,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *446 - - *447 + - *463 + - *464 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -85388,7 +87049,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *644 examples: default-response: summary: Default response @@ -85429,7 +87090,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85447,8 +87108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -85458,7 +87119,7 @@ paths: application/json: schema: type: array - items: &628 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -85512,7 +87173,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &877 + last_response: &895 title: Hook Response type: object properties: @@ -85586,8 +87247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -85639,9 +87300,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: &629 + default: &646 value: type: Repository id: 12345678 @@ -85689,17 +87350,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '200': description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: *629 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -85719,9 +87380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 requestBody: required: true content: @@ -85766,9 +87427,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *645 examples: - default: *629 + default: *646 '422': *15 '404': *6 x-github: @@ -85789,9 +87450,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -85815,9 +87476,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '200': description: Response @@ -85844,9 +87505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 requestBody: required: false content: @@ -85890,11 +87551,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *17 - - *320 + - *338 responses: '200': description: Response @@ -85902,9 +87563,9 @@ paths: application/json: schema: type: array - items: *321 + items: *339 examples: - default: *322 + default: *340 '400': *14 '422': *15 x-github: @@ -85923,18 +87584,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *16 responses: '200': description: Response content: application/json: - schema: *323 + schema: *341 examples: - default: *324 + default: *342 '400': *14 '422': *15 x-github: @@ -85953,9 +87614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 - *16 responses: '202': *39 @@ -85978,9 +87639,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -86005,9 +87666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *446 - - *447 - - *319 + - *463 + - *464 + - *337 responses: '204': description: Response @@ -86030,8 +87691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response if immutable releases are enabled @@ -86077,11 +87738,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 - '409': *109 + '204': *143 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86098,11 +87759,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 - '409': *109 + '204': *143 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86156,14 +87817,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &630 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -86262,7 +87923,7 @@ paths: - html_url - authors_url examples: - default: &633 + default: &650 value: vcs: subversion use_lfs: true @@ -86278,7 +87939,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &631 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -86307,8 +87968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -86356,7 +88017,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: default: value: @@ -86381,7 +88042,7 @@ paths: type: string '422': *15 '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86409,8 +88070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -86459,7 +88120,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: example-1: summary: Example 1 @@ -86507,7 +88168,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86530,12 +88191,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86561,9 +88222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *446 - - *447 - - &818 + - *463 + - *464 + - &836 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86577,7 +88238,7 @@ paths: application/json: schema: type: array - items: &632 + items: &649 title: Porter Author description: Porter Author type: object @@ -86631,7 +88292,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86656,8 +88317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *446 - - *447 + - *463 + - *464 - name: author_id in: path required: true @@ -86687,7 +88348,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *649 examples: default: value: @@ -86700,7 +88361,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86724,8 +88385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86766,7 +88427,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86794,8 +88455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -86822,11 +88483,11 @@ paths: description: Response content: application/json: - schema: *630 + schema: *647 examples: - default: *633 + default: *650 '422': *15 - '503': *631 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86849,8 +88510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86858,8 +88519,8 @@ paths: application/json: schema: *22 examples: - default: *634 - '301': *460 + default: *651 + '301': *477 '404': *6 x-github: githubCloudOnly: false @@ -86879,8 +88540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -86888,12 +88549,12 @@ paths: application/json: schema: anyOf: - - *337 + - *355 - type: object properties: {} additionalProperties: false examples: - default: &636 + default: &653 value: limit: collaborators_only origin: repository @@ -86918,13 +88579,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: application/json: - schema: *635 + schema: *652 examples: default: summary: Example request body @@ -86936,9 +88597,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: - default: *636 + default: *653 '409': description: Response x-github: @@ -86960,8 +88621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -86984,8 +88645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -86995,9 +88656,9 @@ paths: application/json: schema: type: array - items: *637 + items: *654 examples: - default: &811 + default: &829 value: - id: 1 repository: @@ -87128,9 +88789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *446 - - *447 - - *341 + - *463 + - *464 + - *359 requestBody: required: false content: @@ -87159,7 +88820,7 @@ paths: description: Response content: application/json: - schema: *637 + schema: *654 examples: default: value: @@ -87290,9 +88951,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *446 - - *447 - - *341 + - *463 + - *464 + - *359 responses: '204': description: Response @@ -87323,8 +88984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *446 - - *447 + - *463 + - *464 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -87372,7 +89033,7 @@ paths: required: false schema: type: string - - *345 + - *363 - name: sort description: What to sort results by. in: query @@ -87384,8 +89045,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -87395,9 +89056,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: &646 + default: &663 value: - id: 1 node_id: MDU6SXNzdWUx @@ -87545,7 +89206,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *460 + '301': *477 '422': *15 '404': *6 x-github: @@ -87574,8 +89235,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -87657,9 +89318,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: &643 + default: &660 value: id: 1 node_id: MDU6SXNzdWUx @@ -87813,9 +89474,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *167 + '503': *183 '404': *6 - '410': *457 + '410': *474 x-github: triggersNotification: true githubCloudOnly: false @@ -87843,9 +89504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *446 - - *447 - - *213 + - *463 + - *464 + - *230 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -87855,7 +89516,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -87865,9 +89526,9 @@ paths: application/json: schema: type: array - items: *638 + items: *655 examples: - default: &645 + default: &662 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87925,17 +89586,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: &639 + default: &656 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87989,9 +89650,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -88013,9 +89674,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 '422': *15 x-github: githubCloudOnly: false @@ -88033,9 +89694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -88055,9 +89716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -88083,9 +89744,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -88106,9 +89767,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -88140,16 +89801,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -88171,10 +89832,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -88194,8 +89855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -88205,7 +89866,7 @@ paths: application/json: schema: type: array - items: &642 + items: &659 title: Issue Event description: Issue Event type: object @@ -88248,8 +89909,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *640 - required: *641 + properties: *657 + required: *658 nullable: true label: title: Issue Event Label @@ -88293,7 +89954,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *282 + requested_team: *302 dismissed_review: title: Issue Event Dismissed Review type: object @@ -88358,7 +90019,7 @@ paths: required: - from - to - author_association: *190 + author_association: *207 lock_reason: type: string nullable: true @@ -88371,8 +90032,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 required: - id - node_id @@ -88556,8 +90217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *446 - - *447 + - *463 + - *464 - name: event_id in: path required: true @@ -88568,7 +90229,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *659 examples: default: value: @@ -88761,7 +90422,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *457 + '410': *474 '403': *29 x-github: githubCloudOnly: false @@ -88795,9 +90456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *446 - - *447 - - &644 + - *463 + - *464 + - &661 name: issue_number description: The number that identifies the issue. in: path @@ -88809,12 +90470,12 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '404': *6 - '410': *457 + '410': *474 '304': *37 x-github: githubCloudOnly: false @@ -88839,9 +90500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -88945,15 +90606,15 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 '422': *15 - '503': *167 + '503': *183 '403': *29 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88971,9 +90632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -88999,9 +90660,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89017,9 +90678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: content: application/json: @@ -89044,9 +90705,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89068,9 +90729,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: assignee in: path required: true @@ -89110,10 +90771,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *446 - - *447 - - *644 - - *196 + - *463 + - *464 + - *661 + - *213 - *17 - *19 responses: @@ -89123,13 +90784,13 @@ paths: application/json: schema: type: array - items: *638 + items: *655 examples: - default: *645 + default: *662 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89158,9 +90819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -89182,16 +90843,16 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -89219,9 +90880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89231,14 +90892,14 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89266,9 +90927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -89290,17 +90951,17 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *460 + '301': *477 '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -89331,9 +90992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -89345,15 +91006,15 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 x-github: triggersNotification: true githubCloudOnly: false @@ -89379,9 +91040,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89391,14 +91052,14 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89415,9 +91076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -89431,7 +91092,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &648 + - &665 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -89462,8 +91123,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 label: type: object properties: @@ -89485,7 +91146,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &649 + - &666 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -89516,8 +91177,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 label: type: object properties: @@ -89605,8 +91266,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 assigner: *4 required: @@ -89621,7 +91282,7 @@ paths: - performed_via_github_app - assignee - assigner - - &650 + - &667 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -89652,8 +91313,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 milestone: type: object properties: @@ -89672,7 +91333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &651 + - &668 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -89703,8 +91364,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 milestone: type: object properties: @@ -89723,7 +91384,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &652 + - &669 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -89754,8 +91415,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 rename: type: object properties: @@ -89777,7 +91438,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &653 + - &670 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -89808,10 +91469,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 review_requester: *4 - requested_team: *282 + requested_team: *302 requested_reviewer: *4 required: - review_requester @@ -89824,7 +91485,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &654 + - &671 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -89855,10 +91516,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 review_requester: *4 - requested_team: *282 + requested_team: *302 requested_reviewer: *4 required: - review_requester @@ -89871,7 +91532,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &655 + - &672 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -89902,8 +91563,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 dismissed_review: type: object properties: @@ -89931,7 +91592,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &656 + - &673 title: Locked Issue Event description: Locked Issue Event type: object @@ -89962,8 +91623,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 lock_reason: type: string example: '"off-topic"' @@ -89979,7 +91640,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &657 + - &674 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -90010,8 +91671,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90045,7 +91706,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &658 + - &675 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -90076,8 +91737,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90111,7 +91772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &659 + - &676 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -90142,8 +91803,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 project_card: type: object properties: @@ -90177,7 +91838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &677 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -90268,7 +91929,7 @@ paths: color: red headers: Link: *43 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90285,9 +91946,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -90297,9 +91958,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: &647 + default: &664 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -90317,9 +91978,9 @@ paths: default: false headers: Link: *43 - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90336,9 +91997,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90397,12 +92058,12 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 - '301': *460 + default: *664 + '301': *477 '404': *6 - '410': *457 + '410': *474 '422': *15 x-github: githubCloudOnly: false @@ -90419,9 +92080,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90481,12 +92142,12 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 - '301': *460 + default: *664 + '301': *477 '404': *6 - '410': *457 + '410': *474 '422': *15 x-github: githubCloudOnly: false @@ -90503,15 +92164,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '204': description: Response - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90530,9 +92191,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: name in: path required: true @@ -90545,7 +92206,7 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: default: value: @@ -90556,9 +92217,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *460 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90578,9 +92239,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: false content: @@ -90608,7 +92269,7 @@ paths: '204': description: Response '403': *29 - '410': *457 + '410': *474 '404': *6 '422': *15 x-github: @@ -90626,9 +92287,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '204': description: Response @@ -90658,20 +92319,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 responses: '200': description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 - '301': *460 + default: *660 + '301': *477 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90688,9 +92349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -90716,13 +92377,13 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90740,9 +92401,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90774,16 +92435,16 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -90805,10 +92466,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *446 - - *447 - - *644 - - *438 + - *463 + - *464 + - *661 + - *455 responses: '204': description: Response @@ -90837,9 +92498,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90861,9 +92522,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -90896,9 +92557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -90908,13 +92569,13 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *646 + default: *663 headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90942,9 +92603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -90971,16 +92632,16 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *457 + '410': *474 '422': *15 '404': *6 x-github: @@ -91000,9 +92661,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 requestBody: required: true content: @@ -91033,13 +92694,13 @@ paths: description: Response content: application/json: - schema: *189 + schema: *206 examples: - default: *643 + default: *660 '403': *29 '404': *6 '422': *7 - '503': *167 + '503': *183 x-github: triggersNotification: true githubCloudOnly: false @@ -91057,9 +92718,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *446 - - *447 - - *644 + - *463 + - *464 + - *661 - *17 - *19 responses: @@ -91074,19 +92735,19 @@ paths: description: Timeline Event type: object anyOf: - - *648 - - *649 - - *650 - - *651 - - *652 - - *653 - - *654 - - *655 - - *656 - - *657 - - *658 - - *659 - - *660 + - *665 + - *666 + - *667 + - *668 + - *669 + - *670 + - *671 + - *672 + - *673 + - *674 + - *675 + - *676 + - *677 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -91129,7 +92790,7 @@ paths: issue_url: type: string format: uri - author_association: *190 + author_association: *207 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -91139,9 +92800,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - event - actor @@ -91172,7 +92833,7 @@ paths: properties: type: type: string - issue: *189 + issue: *206 required: - event - created_at @@ -91372,7 +93033,7 @@ paths: type: string body_text: type: string - author_association: *190 + author_association: *207 required: - event - id @@ -91395,7 +93056,7 @@ paths: type: string comments: type: array - items: &680 + items: &699 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -91484,7 +93145,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *190 + author_association: *207 _links: type: object properties: @@ -91568,7 +93229,7 @@ paths: enum: - line - file - reactions: *191 + reactions: *208 body_html: type: string example: '"

comment body

"' @@ -91604,7 +93265,7 @@ paths: type: string comments: type: array - items: *563 + items: *580 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -91635,8 +93296,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 required: - id @@ -91679,8 +93340,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 assignee: *4 required: - id @@ -91723,8 +93384,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 state_reason: type: string nullable: true @@ -91893,7 +93554,7 @@ paths: headers: Link: *43 '404': *6 - '410': *457 + '410': *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91910,8 +93571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -91921,7 +93582,7 @@ paths: application/json: schema: type: array - items: &661 + items: &678 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -91987,8 +93648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92024,9 +93685,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *678 examples: - default: &662 + default: &679 value: id: 1 key: ssh-rsa AAA... @@ -92060,9 +93721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *446 - - *447 - - &663 + - *463 + - *464 + - &680 name: key_id description: The unique identifier of the key. in: path @@ -92074,9 +93735,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *678 examples: - default: *662 + default: *679 '404': *6 x-github: githubCloudOnly: false @@ -92094,9 +93755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *446 - - *447 - - *663 + - *463 + - *464 + - *680 responses: '204': description: Response @@ -92116,8 +93777,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -92127,9 +93788,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 + default: *664 headers: Link: *43 '404': *6 @@ -92150,8 +93811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92187,9 +93848,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: - default: &664 + default: &681 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92221,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92233,9 +93894,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: - default: *664 + default: *681 '404': *6 x-github: githubCloudOnly: false @@ -92252,8 +93913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92292,7 +93953,7 @@ paths: description: Response content: application/json: - schema: *188 + schema: *205 examples: default: value: @@ -92318,8 +93979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *446 - - *447 + - *463 + - *464 - name: name in: path required: true @@ -92345,8 +94006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -92382,8 +94043,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '202': *39 '403': @@ -92411,8 +94072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -92438,9 +94099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *446 - - *447 - - *539 + - *463 + - *464 + - *556 responses: '200': description: Response @@ -92502,8 +94163,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true required: - _links @@ -92585,8 +94246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92651,8 +94312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92686,9 +94347,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *564 + schema: *581 examples: - default: *665 + default: *682 '204': description: Response when already merged '404': @@ -92713,8 +94374,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -92755,12 +94416,12 @@ paths: application/json: schema: type: array - items: &666 + items: &683 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 examples: default: value: @@ -92816,8 +94477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -92857,9 +94518,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: &667 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -92918,9 +94579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *446 - - *447 - - &668 + - *463 + - *464 + - &685 name: milestone_number description: The number that identifies the milestone. in: path @@ -92932,9 +94593,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: *667 + default: *684 '404': *6 x-github: githubCloudOnly: false @@ -92951,9 +94612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 requestBody: required: false content: @@ -92991,9 +94652,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *683 examples: - default: *667 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93009,9 +94670,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 responses: '204': description: Response @@ -93032,9 +94693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *446 - - *447 - - *668 + - *463 + - *464 + - *685 - *17 - *19 responses: @@ -93044,9 +94705,9 @@ paths: application/json: schema: type: array - items: *188 + items: *205 examples: - default: *647 + default: *664 headers: Link: *43 x-github: @@ -93065,12 +94726,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *446 - - *447 - - *669 - - *670 - - *196 - - *671 + - *463 + - *464 + - *686 + - *687 + - *213 + - *688 - *17 - *19 responses: @@ -93080,9 +94741,9 @@ paths: application/json: schema: type: array - items: *216 + items: *233 examples: - default: *672 + default: *689 headers: Link: *43 x-github: @@ -93106,8 +94767,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -93165,14 +94826,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: &673 + schema: &690 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -93297,7 +94958,7 @@ paths: - custom_404 - public examples: - default: &674 + default: &691 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -93338,8 +94999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93393,11 +95054,11 @@ paths: description: Response content: application/json: - schema: *673 + schema: *690 examples: - default: *674 + default: *691 '422': *15 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93418,8 +95079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93505,7 +95166,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93526,14 +95187,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response '422': *15 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93553,8 +95214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -93564,7 +95225,7 @@ paths: application/json: schema: type: array - items: &675 + items: &692 title: Page Build description: Page Build type: object @@ -93658,8 +95319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *446 - - *447 + - *463 + - *464 responses: '201': description: Response @@ -93704,16 +95365,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *675 + schema: *692 examples: - default: &676 + default: &693 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -93761,8 +95422,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *446 - - *447 + - *463 + - *464 - name: build_id in: path required: true @@ -93773,9 +95434,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *692 examples: - default: *676 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93795,8 +95456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -93901,9 +95562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *446 - - *447 - - &677 + - *463 + - *464 + - &694 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -93961,11 +95622,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *446 - - *447 - - *677 + - *463 + - *464 + - *694 responses: - '204': *133 + '204': *143 '404': *6 x-github: githubCloudOnly: false @@ -93990,8 +95651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -94222,7 +95883,7 @@ paths: description: Empty response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -94249,8 +95910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Private vulnerability reporting status @@ -94287,10 +95948,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 + '204': *143 '422': *14 x-github: githubCloudOnly: false @@ -94309,10 +95970,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: - '204': *133 + '204': *143 '422': *14 x-github: githubCloudOnly: false @@ -94333,8 +95994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: Indicates the state of the projects to return. in: query @@ -94355,7 +96016,7 @@ paths: application/json: schema: type: array - items: *374 + items: *392 examples: default: value: @@ -94395,7 +96056,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -94418,8 +96079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94445,13 +96106,13 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: - default: *456 + default: *473 '401': *25 '403': *29 '404': *6 - '410': *457 + '410': *474 '422': *7 x-github: githubCloudOnly: false @@ -94474,8 +96135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -94483,16 +96144,9 @@ paths: application/json: schema: type: array - items: *389 + items: *144 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *695 '403': *29 '404': *6 x-github: @@ -94514,8 +96168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94527,19 +96181,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *389 + items: *144 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *696 responses: '204': description: No Content when custom property values are successfully created @@ -94577,8 +96223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *446 - - *447 + - *463 + - *464 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -94638,9 +96284,9 @@ paths: application/json: schema: type: array - items: *568 + items: *585 examples: - default: *678 + default: *697 headers: Link: *43 '304': *37 @@ -94672,8 +96318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -94738,7 +96384,7 @@ paths: description: Response content: application/json: - schema: &682 + schema: &701 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -94849,8 +96495,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true active_lock_reason: type: string @@ -94895,7 +96541,7 @@ paths: nullable: true requested_teams: type: array - items: *413 + items: *430 nullable: true head: type: object @@ -94904,7 +96550,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: *4 @@ -94921,7 +96567,7 @@ paths: type: string ref: type: string - repo: *69 + repo: *74 sha: type: string user: *4 @@ -94934,14 +96580,14 @@ paths: _links: type: object properties: - comments: *382 - commits: *382 - statuses: *382 - html: *382 - issue: *382 - review_comments: *382 - review_comment: *382 - self: *382 + comments: *400 + commits: *400 + statuses: *400 + html: *400 + issue: *400 + review_comments: *400 + review_comment: *400 + self: *400 required: - comments - commits @@ -94951,8 +96597,8 @@ paths: - review_comments - review_comment - self - author_association: *190 - auto_merge: *679 + author_association: *207 + auto_merge: *698 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -95044,7 +96690,7 @@ paths: - merged_by - review_comments examples: - default: &683 + default: &702 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -95571,8 +97217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: sort in: query required: false @@ -95591,7 +97237,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -95601,9 +97247,9 @@ paths: application/json: schema: type: array - items: *680 + items: *699 examples: - default: &685 + default: &704 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95680,17 +97326,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '200': description: Response content: application/json: - schema: *680 + schema: *699 examples: - default: &681 + default: &700 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95765,9 +97411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -95789,9 +97435,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: - default: *681 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95807,9 +97453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 responses: '204': description: Response @@ -95830,9 +97476,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -95858,9 +97504,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -95881,9 +97527,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *446 - - *447 - - *205 + - *463 + - *464 + - *222 requestBody: required: true content: @@ -95915,16 +97561,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -95946,10 +97592,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *446 - - *447 - - *205 - - *438 + - *463 + - *464 + - *222 + - *455 responses: '204': description: Response @@ -95992,9 +97638,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *446 - - *447 - - &684 + - *463 + - *464 + - &703 name: pull_number description: The number that identifies the pull request. in: path @@ -96007,9 +97653,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *682 + schema: *701 examples: - default: *683 + default: *702 '304': *37 '404': *6 '406': @@ -96018,7 +97664,7 @@ paths: application/json: schema: *3 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96044,9 +97690,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96088,9 +97734,9 @@ paths: description: Response content: application/json: - schema: *682 + schema: *701 examples: - default: *683 + default: *702 '422': *15 '403': *29 x-github: @@ -96112,9 +97758,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -96174,21 +97820,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96214,10 +97860,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *446 - - *447 - - *684 - - *213 + - *463 + - *464 + - *703 + - *230 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -96227,7 +97873,7 @@ paths: enum: - asc - desc - - *196 + - *213 - *17 - *19 responses: @@ -96237,9 +97883,9 @@ paths: application/json: schema: type: array - items: *680 + items: *699 examples: - default: *685 + default: *704 headers: Link: *43 x-github: @@ -96272,9 +97918,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -96379,7 +98025,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: example-for-a-multi-line-comment: value: @@ -96467,10 +98113,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *446 - - *447 - - *684 - - *205 + - *463 + - *464 + - *703 + - *222 requestBody: required: true content: @@ -96492,7 +98138,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *699 examples: default: value: @@ -96578,9 +98224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -96590,9 +98236,9 @@ paths: application/json: schema: type: array - items: *564 + items: *581 examples: - default: *686 + default: *705 headers: Link: *43 x-github: @@ -96622,9 +98268,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -96634,7 +98280,7 @@ paths: application/json: schema: type: array - items: *577 + items: *594 examples: default: value: @@ -96653,7 +98299,7 @@ paths: Link: *43 '422': *15 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96672,9 +98318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 responses: '204': description: Response if pull request has been merged @@ -96697,9 +98343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96810,9 +98456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 responses: '200': description: Response @@ -96828,7 +98474,7 @@ paths: items: *4 teams: type: array - items: *282 + items: *302 required: - users - teams @@ -96887,9 +98533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -96926,7 +98572,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *585 examples: default: value: @@ -97462,9 +99108,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: true content: @@ -97498,7 +99144,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *585 examples: default: value: @@ -98003,9 +99649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 - *17 - *19 responses: @@ -98015,7 +99661,7 @@ paths: application/json: schema: type: array - items: &687 + items: &706 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -98084,7 +99730,7 @@ paths: type: string body_text: type: string - author_association: *190 + author_association: *207 required: - id - node_id @@ -98166,9 +99812,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -98254,9 +99900,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: &689 + default: &708 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98319,10 +99965,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - &688 + - *463 + - *464 + - *703 + - &707 name: review_id description: The unique identifier of the review. in: path @@ -98334,9 +99980,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: &690 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98395,10 +100041,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98421,7 +100067,7 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: default: value: @@ -98483,18 +100129,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 responses: '200': description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: *689 + default: *708 '422': *7 '404': *6 x-github: @@ -98521,10 +100167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 - *17 - *19 responses: @@ -98603,13 +100249,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *190 + author_association: *207 _links: type: object properties: - self: *382 - html: *382 - pull_request: *382 + self: *400 + html: *400 + pull_request: *400 required: - self - html @@ -98618,7 +100264,7 @@ paths: type: string body_html: type: string - reactions: *191 + reactions: *208 side: description: The side of the first line of the range for a multi-line comment. @@ -98759,10 +100405,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98790,7 +100436,7 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: default: value: @@ -98853,10 +100499,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *446 - - *447 - - *684 - - *688 + - *463 + - *464 + - *703 + - *707 requestBody: required: true content: @@ -98891,9 +100537,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *706 examples: - default: *690 + default: *709 '404': *6 '422': *7 '403': *29 @@ -98915,9 +100561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *446 - - *447 - - *684 + - *463 + - *464 + - *703 requestBody: required: false content: @@ -98980,8 +100626,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *446 - - *447 + - *463 + - *464 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -98994,9 +100640,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *710 examples: - default: &692 + default: &711 value: type: file encoding: base64 @@ -99038,8 +100684,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *446 - - *447 + - *463 + - *464 - name: dir description: The alternate path to look for a README file in: path @@ -99059,9 +100705,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *710 examples: - default: *692 + default: *711 '404': *6 '422': *15 x-github: @@ -99083,8 +100729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -99094,7 +100740,7 @@ paths: application/json: schema: type: array - items: *693 + items: *712 examples: default: value: @@ -99188,8 +100834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -99265,9 +100911,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: &697 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -99372,9 +101018,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *446 - - *447 - - &695 + - *463 + - *464 + - &714 name: asset_id description: The unique identifier of the asset. in: path @@ -99386,9 +101032,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: - default: &696 + default: &715 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -99423,7 +101069,7 @@ paths: type: User site_admin: false '404': *6 - '302': *579 + '302': *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99439,9 +101085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *446 - - *447 - - *695 + - *463 + - *464 + - *714 requestBody: required: false content: @@ -99469,9 +101115,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: - default: *696 + default: *715 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99487,9 +101133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *446 - - *447 - - *695 + - *463 + - *464 + - *714 responses: '204': description: Response @@ -99513,8 +101159,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -99599,16 +101245,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99625,8 +101271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *446 - - *447 + - *463 + - *464 - name: tag description: tag parameter in: path @@ -99639,9 +101285,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '404': *6 x-github: githubCloudOnly: false @@ -99663,9 +101309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *446 - - *447 - - &698 + - *463 + - *464 + - &717 name: release_id description: The unique identifier of the release. in: path @@ -99679,9 +101325,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '401': description: Unauthorized x-github: @@ -99699,9 +101345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 requestBody: required: false content: @@ -99765,9 +101411,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *712 examples: - default: *697 + default: *716 '404': description: Not Found if the discussion category name is invalid content: @@ -99788,9 +101434,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 responses: '204': description: Response @@ -99810,9 +101456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - *17 - *19 responses: @@ -99822,7 +101468,7 @@ paths: application/json: schema: type: array - items: *694 + items: *713 examples: default: value: @@ -99904,9 +101550,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - name: name in: query required: true @@ -99932,7 +101578,7 @@ paths: description: Response for successful upload content: application/json: - schema: *694 + schema: *713 examples: response-for-successful-upload: value: @@ -99987,9 +101633,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -100013,9 +101659,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 '404': *6 @@ -100036,9 +101682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *446 - - *447 - - *698 + - *463 + - *464 + - *717 requestBody: required: true content: @@ -100068,16 +101714,16 @@ paths: description: Reaction exists content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '201': description: Reaction created content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '422': *15 x-github: githubCloudOnly: false @@ -100099,10 +101745,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *446 - - *447 - - *698 - - *438 + - *463 + - *464 + - *717 + - *455 responses: '204': description: Response @@ -100126,9 +101772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *446 - - *447 - - *505 + - *463 + - *464 + - *522 - *17 - *19 responses: @@ -100144,8 +101790,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *142 - - &699 + - *158 + - &718 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -100165,68 +101811,68 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: - - *143 - - *699 + - *159 + - *718 - allOf: - - *144 - - *699 + - *160 + - *718 - allOf: - - *145 - - *699 + - *161 + - *718 - allOf: - - *700 - - *699 + - *719 + - *718 - allOf: - - *146 - - *699 + - *162 + - *718 - allOf: - - *147 - - *699 + - *163 + - *718 - allOf: - - *148 - - *699 + - *164 + - *718 - allOf: - - *149 - - *699 + - *165 + - *718 - allOf: - - *150 - - *699 + - *166 + - *718 - allOf: - - *151 - - *699 + - *167 + - *718 - allOf: - - *152 - - *699 + - *168 + - *718 - allOf: - - *153 - - *699 + - *169 + - *718 - allOf: - - *154 - - *699 + - *170 + - *718 - allOf: - - *155 - - *699 + - *171 + - *718 - allOf: - - *156 - - *699 + - *172 + - *718 - allOf: - - *157 - - *699 + - *173 + - *718 - allOf: - - *158 - - *699 + - *174 + - *718 - allOf: - - *159 - - *699 + - *175 + - *718 - allOf: - - *160 - - *699 + - *176 + - *718 - allOf: - - *161 - - *699 + - *177 + - *718 - allOf: - - *701 - - *699 + - *720 + - *718 examples: default: value: @@ -100265,8 +101911,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - name: includes_parents @@ -100277,7 +101923,7 @@ paths: schema: type: boolean default: true - - *702 + - *721 responses: '200': description: Response @@ -100285,7 +101931,7 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: default: value: @@ -100332,8 +101978,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 requestBody: description: Request body required: true @@ -100353,16 +101999,16 @@ paths: - tag - push default: branch - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *136 + items: *157 + conditions: *150 rules: type: array description: An array of rules within the ruleset. - items: *703 + items: *722 required: - name - enforcement @@ -100393,9 +102039,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: &712 + default: &731 value: id: 42 name: super cool ruleset @@ -100442,12 +102088,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *446 - - *447 - - *704 - - *96 - - *705 - - *706 + - *463 + - *464 + - *723 + - *101 + - *724 + - *725 - *17 - *19 responses: @@ -100455,9 +102101,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *726 examples: - default: *708 + default: *727 '404': *6 '500': *40 x-github: @@ -100478,17 +102124,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *446 - - *447 - - *709 + - *463 + - *464 + - *728 responses: '200': description: Response content: application/json: - schema: *710 + schema: *729 examples: - default: *711 + default: *730 '404': *6 '500': *40 x-github: @@ -100516,8 +102162,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100537,9 +102183,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *712 + default: *731 '404': *6 '500': *40 put: @@ -100557,8 +102203,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100583,16 +102229,16 @@ paths: - branch - tag - push - enforcement: *140 + enforcement: *156 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *141 - conditions: *136 + items: *157 + conditions: *150 rules: description: An array of rules within the ruleset. type: array - items: *703 + items: *722 examples: default: value: @@ -100620,9 +102266,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *178 examples: - default: *712 + default: *731 '404': *6 '500': *40 delete: @@ -100640,8 +102286,8 @@ paths: category: repos subcategory: rules parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100664,8 +102310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 - name: ruleset_id @@ -100681,9 +102327,9 @@ paths: application/json: schema: type: array - items: *166 + items: *182 examples: - default: *398 + default: *415 '404': *6 '500': *40 x-github: @@ -100702,8 +102348,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *446 - - *447 + - *463 + - *464 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100721,7 +102367,7 @@ paths: description: Response content: application/json: - schema: *399 + schema: *416 examples: default: value: @@ -100776,21 +102422,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *446 - - *447 - - *400 - - *401 - - *402 - - *403 - - *101 + - *463 + - *464 + - *417 + - *418 + - *419 + - *420 + - *106 - *19 - *17 - - *713 - - *714 - - *404 - - *405 - - *406 - - *407 + - *732 + - *733 + - *421 + - *422 + - *423 + - *424 responses: '200': description: Response @@ -100798,11 +102444,11 @@ paths: application/json: schema: type: array - items: &718 + items: &737 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -100810,15 +102456,15 @@ paths: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *715 - resolution: *716 + state: *734 + resolution: *735 resolved_at: type: string format: date-time @@ -100914,7 +102560,7 @@ paths: pull request. ' - oneOf: *717 + oneOf: *736 nullable: true has_more_locations: type: boolean @@ -101041,7 +102687,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101063,16 +102709,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 - - *407 + - *463 + - *464 + - *550 + - *424 responses: '200': description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -101103,7 +102749,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101124,9 +102770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 requestBody: required: true content: @@ -101134,8 +102780,8 @@ paths: schema: type: object properties: - state: *715 - resolution: *716 + state: *734 + resolution: *735 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -101153,7 +102799,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -101206,7 +102852,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -101228,9 +102874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *446 - - *447 - - *533 + - *463 + - *464 + - *550 - *19 - *17 responses: @@ -101241,7 +102887,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &899 + items: &917 type: object properties: type: @@ -101267,19 +102913,19 @@ paths: example: commit details: oneOf: - - *719 - - *720 - - *721 - - *722 - - *723 - - *724 - - *725 - - *726 - - *727 - - *728 - - *729 - - *730 - - *731 + - *738 + - *739 + - *740 + - *741 + - *742 + - *743 + - *744 + - *745 + - *746 + - *747 + - *748 + - *749 + - *750 examples: default: value: @@ -101343,7 +102989,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101365,8 +103011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -101374,14 +103020,14 @@ paths: schema: type: object properties: - reason: &733 + reason: &752 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *732 + placeholder_id: *751 required: - reason - placeholder_id @@ -101398,7 +103044,7 @@ paths: schema: type: object properties: - reason: *733 + reason: *752 expire_at: type: string format: date-time @@ -101421,7 +103067,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *167 + '503': *183 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -101433,6 +103079,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -101441,13 +103090,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *167 + '503': *183 '200': description: Response content: @@ -101457,7 +103106,7 @@ paths: properties: incremental_scans: type: array - items: &734 + items: &753 description: Information on a single scan performed by secret scanning on the repository type: object @@ -101483,15 +103132,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *734 + items: *753 backfill_scans: type: array - items: *734 + items: *753 custom_pattern_backfill_scans: type: array items: allOf: - - *734 + - *753 - type: object properties: pattern_name: @@ -101561,9 +103210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *446 - - *447 - - *101 + - *463 + - *464 + - *106 - name: sort description: The property to sort the results by. in: query @@ -101575,8 +103224,8 @@ paths: - updated - published default: created - - *99 - - *100 + - *104 + - *105 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -101606,9 +103255,9 @@ paths: application/json: schema: type: array - items: *735 + items: *754 examples: - default: *736 + default: *755 '400': *14 '404': *6 x-github: @@ -101631,8 +103280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -101705,7 +103354,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 required: - login - type @@ -101792,9 +103441,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: &738 + default: &757 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -102027,8 +103676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -102132,7 +103781,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: default: value: @@ -102279,17 +103928,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '200': description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: *738 + default: *757 '403': *29 '404': *6 x-github: @@ -102313,9 +103962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 requestBody: required: true content: @@ -102388,7 +104037,7 @@ paths: login: type: string description: The username of the user credited. - type: *412 + type: *429 required: - login - type @@ -102474,17 +104123,17 @@ paths: description: Response content: application/json: - schema: *735 + schema: *754 examples: - default: *738 - add_credit: *738 + default: *757 + add_credit: *757 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *232 + schema: *250 examples: invalid_state_transition: value: @@ -102515,9 +104164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '202': *39 '400': *14 @@ -102544,17 +104193,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *446 - - *447 - - *737 + - *463 + - *464 + - *756 responses: '202': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 '400': *14 '422': *15 '403': *29 @@ -102580,8 +104229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -102680,8 +104329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -102690,7 +104339,7 @@ paths: application/json: schema: type: array - items: &739 + items: &758 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -102703,7 +104352,7 @@ paths: - 1124 - -435 '202': *39 - '204': *133 + '204': *143 '422': description: Repository contains more than 10,000 commits x-github: @@ -102723,8 +104372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -102773,7 +104422,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102800,8 +104449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -102875,7 +104524,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102897,8 +104546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -103052,8 +104701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -103063,7 +104712,7 @@ paths: application/json: schema: type: array - items: *739 + items: *758 examples: default: value: @@ -103076,7 +104725,7 @@ paths: - - 0 - 2 - 21 - '204': *133 + '204': *143 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103096,8 +104745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *446 - - *447 + - *463 + - *464 - name: sha in: path required: true @@ -103151,7 +104800,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *759 examples: default: value: @@ -103205,8 +104854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103218,7 +104867,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -103238,14 +104887,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &741 + schema: &760 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -103313,8 +104962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: false content: @@ -103340,7 +104989,7 @@ paths: description: Response content: application/json: - schema: *741 + schema: *760 examples: default: value: @@ -103367,8 +105016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -103388,8 +105037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103468,8 +105117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -103477,7 +105126,7 @@ paths: application/json: schema: type: array - items: &742 + items: &761 title: Tag protection description: Tag protection type: object @@ -103529,8 +105178,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -103553,7 +105202,7 @@ paths: description: Response content: application/json: - schema: *742 + schema: *761 examples: default: value: @@ -103584,8 +105233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -103622,8 +105271,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *446 - - *447 + - *463 + - *464 - name: ref in: path required: true @@ -103659,8 +105308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *446 - - *447 + - *463 + - *464 - *17 - *19 responses: @@ -103670,9 +105319,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - default: *357 + default: *375 headers: Link: *43 '404': *6 @@ -103692,8 +105341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *446 - - *447 + - *463 + - *464 - *19 - *17 responses: @@ -103701,7 +105350,7 @@ paths: description: Response content: application/json: - schema: &743 + schema: &762 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -103713,7 +105362,7 @@ paths: required: - names examples: - default: &744 + default: &763 value: names: - octocat @@ -103736,8 +105385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -103768,9 +105417,9 @@ paths: description: Response content: application/json: - schema: *743 + schema: *762 examples: - default: *744 + default: *763 '404': *6 '422': *7 x-github: @@ -103791,9 +105440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *446 - - *447 - - &745 + - *463 + - *464 + - &764 name: per description: The time frame to display results for. in: query @@ -103822,7 +105471,7 @@ paths: example: 128 clones: type: array - items: &746 + items: &765 title: Traffic type: object properties: @@ -103909,8 +105558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -104000,8 +105649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *446 - - *447 + - *463 + - *464 responses: '200': description: Response @@ -104061,9 +105710,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *446 - - *447 - - *745 + - *463 + - *464 + - *764 responses: '200': description: Response @@ -104082,7 +105731,7 @@ paths: example: 3782 views: type: array - items: *746 + items: *765 required: - uniques - count @@ -104159,8 +105808,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *446 - - *447 + - *463 + - *464 requestBody: required: true content: @@ -104196,7 +105845,7 @@ paths: description: Response content: application/json: - schema: *255 + schema: *275 examples: default: value: @@ -104434,8 +106083,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -104458,8 +106107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -104481,8 +106130,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -104508,8 +106157,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *446 - - *447 + - *463 + - *464 - name: ref in: path required: true @@ -104601,9 +106250,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -104644,7 +106293,7 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: default: value: @@ -104754,7 +106403,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &754 + - &773 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -104763,7 +106412,7 @@ paths: schema: type: string example: members - - &759 + - &778 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -104774,7 +106423,7 @@ paths: default: 1 format: int32 example: 1 - - &760 + - &779 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -104816,7 +106465,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &749 + items: &768 allOf: - type: object required: @@ -104891,7 +106540,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &761 + meta: &780 type: object description: The metadata associated with the creation/updates to the user. @@ -104951,30 +106600,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &750 + '400': &769 description: Bad request content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '401': *748 - '403': &751 + schema: *766 + '401': *767 + '403': &770 description: Permission denied - '429': &752 + '429': &771 description: Too many requests content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '500': &753 + schema: *766 + '500': &772 description: Internal server error content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 + schema: *766 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -104998,7 +106647,7 @@ paths: required: true content: application/json: - schema: &757 + schema: &776 type: object required: - schemas @@ -105058,9 +106707,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *749 + schema: *768 examples: - group: &755 + group: &774 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -105079,13 +106728,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *750 - '401': *748 - '403': *751 - '409': &758 + '400': *769 + '401': *767 + '403': *770 + '409': &777 description: Duplicate record detected - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105102,7 +106751,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &756 + - &775 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -105110,22 +106759,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *754 + - *773 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *749 + schema: *768 examples: - default: *755 - '400': *750 - '401': *748 - '403': *751 + default: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105144,13 +106793,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *756 + - *775 - *41 requestBody: required: true content: application/json: - schema: *757 + schema: *776 examples: group: summary: Group @@ -105176,17 +106825,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *749 + schema: *768 examples: - group: *755 - groupWithMembers: *755 - '400': *750 - '401': *748 - '403': *751 + group: *774 + groupWithMembers: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105210,13 +106859,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *756 + - *775 - *41 requestBody: required: true content: application/json: - schema: &768 + schema: &787 type: object required: - Operations @@ -105276,17 +106925,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *749 + schema: *768 examples: - updateGroup: *755 - addMembers: *755 - '400': *750 - '401': *748 - '403': *751 + updateGroup: *774 + addMembers: *774 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105302,17 +106951,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *756 + - *775 - *41 responses: '204': description: Group was deleted, no content - '400': *750 - '401': *748 - '403': *751 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105346,8 +106995,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *759 - - *760 + - *778 + - *779 - *41 responses: '200': @@ -105380,7 +107029,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &763 + items: &782 allOf: - type: object required: @@ -105459,7 +107108,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &762 + roles: &781 type: array description: The roles assigned to the user. items: @@ -105515,7 +107164,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *761 + meta: *780 startIndex: type: integer description: A starting index for the returned page @@ -105552,11 +107201,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *750 - '401': *748 - '403': *751 - '429': *752 - '500': *753 + '400': *769 + '401': *767 + '403': *770 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105580,7 +107229,7 @@ paths: required: true content: application/json: - schema: &766 + schema: &785 type: object required: - schemas @@ -105662,9 +107311,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *762 + roles: *781 examples: - user: &767 + user: &786 summary: User value: schemas: @@ -105711,9 +107360,9 @@ paths: description: User has been created content: application/scim+json: - schema: *763 + schema: *782 examples: - user: &764 + user: &783 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -105739,13 +107388,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *764 - '400': *750 - '401': *748 - '403': *751 - '409': *758 - '429': *752 - '500': *753 + enterpriseOwner: *783 + '400': *769 + '401': *767 + '403': *770 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105762,7 +107411,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &765 + - &784 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -105775,15 +107424,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *763 + schema: *782 examples: - default: *764 - '400': *750 - '401': *748 - '403': *751 + default: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105805,30 +107454,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *765 + - *784 - *41 requestBody: required: true content: application/json: - schema: *766 + schema: *785 examples: - user: *767 + user: *786 responses: '200': description: User was updated content: application/scim+json: - schema: *763 + schema: *782 examples: - user: *764 - '400': *750 - '401': *748 - '403': *751 + user: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105863,13 +107512,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *765 + - *784 - *41 requestBody: required: true content: application/json: - schema: *768 + schema: *787 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -105909,18 +107558,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *763 + schema: *782 examples: - userMultiValuedProperties: *764 - userSingleValuedProperties: *764 - disableUser: *764 - '400': *750 - '401': *748 - '403': *751 + userMultiValuedProperties: *783 + userSingleValuedProperties: *783 + disableUser: *783 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '409': *758 - '429': *752 - '500': *753 + '409': *777 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105940,17 +107589,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *765 + - *784 - *41 responses: '204': description: User was deleted, no content - '400': *750 - '401': *748 - '403': *751 + '400': *769 + '401': *767 + '403': *770 '404': *6 - '429': *752 - '500': *753 + '429': *771 + '500': *772 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -105983,7 +107632,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *78 + - *83 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -106037,7 +107686,7 @@ paths: example: 1 Resources: type: array - items: &769 + items: &788 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -106268,22 +107917,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &770 + '404': &789 description: Resource not found content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '403': &771 + schema: *766 + '403': &790 description: Forbidden content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '400': *750 - '429': *752 + schema: *766 + '400': *769 + '429': *771 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -106303,15 +107952,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *78 + - *83 responses: '201': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: &772 + default: &791 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -106334,17 +107983,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *770 - '403': *771 - '500': *753 + '404': *789 + '403': *790 + '500': *772 '409': description: Conflict content: application/json: - schema: *747 + schema: *766 application/scim+json: - schema: *747 - '400': *750 + schema: *766 + '400': *769 requestBody: required: true content: @@ -106441,18 +108090,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 - '404': *770 - '403': *771 + default: *791 + '404': *789 + '403': *790 '304': *37 x-github: githubCloudOnly: true @@ -106475,19 +108124,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 + default: *791 '304': *37 - '404': *770 - '403': *771 + '404': *789 + '403': *790 requestBody: required: true content: @@ -106599,20 +108248,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *78 - - *765 + - *83 + - *784 responses: '200': description: Response content: application/scim+json: - schema: *769 + schema: *788 examples: - default: *772 + default: *791 '304': *37 - '404': *770 - '403': *771 - '400': *750 + '404': *789 + '403': *790 + '400': *769 '429': description: Response content: @@ -106702,13 +108351,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *78 - - *765 + - *83 + - *784 responses: '204': description: Response - '404': *770 - '403': *771 + '404': *789 + '403': *790 '304': *37 x-github: githubCloudOnly: true @@ -106823,7 +108472,7 @@ paths: html_url: type: string format: uri - repository: *255 + repository: *275 score: type: number file_size: @@ -106841,7 +108490,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &773 + text_matches: &792 title: Search Result Text Matches type: array items: @@ -106955,7 +108604,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *167 + '503': *183 '422': *15 '403': *29 x-github: @@ -107004,7 +108653,7 @@ paths: enum: - author-date - committer-date - - &774 + - &793 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -107075,7 +108724,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true comment_count: type: integer @@ -107095,7 +108744,7 @@ paths: url: type: string format: uri - verification: *624 + verification: *641 required: - author - committer @@ -107114,7 +108763,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *503 + properties: *520 nullable: true parents: type: array @@ -107127,12 +108776,12 @@ paths: type: string sha: type: string - repository: *255 + repository: *275 score: type: number node_id: type: string - text_matches: *773 + text_matches: *792 required: - sha - node_id @@ -107325,7 +108974,7 @@ paths: - interactions - created - updated - - *774 + - *793 - *17 - *19 - name: advanced_search @@ -107422,11 +109071,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: type: string state_reason: @@ -107443,8 +109092,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *380 - required: *381 + properties: *398 + required: *399 nullable: true comments: type: integer @@ -107458,7 +109107,7 @@ paths: type: string format: date-time nullable: true - text_matches: *773 + text_matches: *792 pull_request: type: object properties: @@ -107491,10 +109140,10 @@ paths: type: string score: type: number - author_association: *190 + author_association: *207 draft: type: boolean - repository: *69 + repository: *74 body_html: type: string body_text: @@ -107502,7 +109151,7 @@ paths: timeline_url: type: string format: uri - type: *342 + type: *360 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -107512,9 +109161,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 - reactions: *191 + properties: *203 + required: *204 + reactions: *208 required: - assignee - closed_at @@ -107630,7 +109279,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *167 + '503': *183 '422': *15 '304': *37 '403': *29 @@ -107683,7 +109332,7 @@ paths: enum: - created - updated - - *774 + - *793 - *17 - *19 responses: @@ -107727,7 +109376,7 @@ paths: nullable: true score: type: number - text_matches: *773 + text_matches: *792 required: - id - node_id @@ -107813,7 +109462,7 @@ paths: - forks - help-wanted-issues - updated - - *774 + - *793 - *17 - *19 responses: @@ -108032,8 +109681,8 @@ paths: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true permissions: type: object @@ -108052,7 +109701,7 @@ paths: - admin - pull - push - text_matches: *773 + text_matches: *792 temp_clone_token: type: string allow_merge_commit: @@ -108254,7 +109903,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *167 + '503': *183 '422': *15 '304': *37 x-github: @@ -108353,7 +110002,7 @@ paths: type: string format: uri nullable: true - text_matches: *773 + text_matches: *792 related: type: array nullable: true @@ -108546,7 +110195,7 @@ paths: - followers - repositories - joined - - *774 + - *793 - *17 - *19 responses: @@ -108650,7 +110299,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *773 + text_matches: *792 blog: type: string nullable: true @@ -108709,7 +110358,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *167 + '503': *183 '422': *15 x-github: githubCloudOnly: false @@ -108729,7 +110378,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &778 + - &797 name: team_id description: The unique identifier of the team. in: path @@ -108741,9 +110390,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 x-github: githubCloudOnly: false @@ -108770,7 +110419,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -108833,16 +110482,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '201': description: Response content: application/json: - schema: *427 + schema: *444 examples: - default: *428 + default: *445 '404': *6 '422': *15 '403': *29 @@ -108870,7 +110519,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *778 + - *797 responses: '204': description: Response @@ -108901,8 +110550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *778 - - *101 + - *797 + - *106 - *17 - *19 responses: @@ -108912,9 +110561,9 @@ paths: application/json: schema: type: array - items: *429 + items: *446 examples: - default: *779 + default: *798 headers: Link: *43 x-github: @@ -108943,7 +110592,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -108977,9 +110626,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: triggersNotification: true githubCloudOnly: false @@ -109006,16 +110655,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 responses: '200': description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *430 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109040,8 +110689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: false content: @@ -109064,9 +110713,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *446 examples: - default: *780 + default: *799 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109091,8 +110740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 responses: '204': description: Response @@ -109121,9 +110770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *778 - - *431 - - *101 + - *797 + - *448 + - *106 - *17 - *19 responses: @@ -109133,9 +110782,9 @@ paths: application/json: schema: type: array - items: *432 + items: *449 examples: - default: *781 + default: *800 headers: Link: *43 x-github: @@ -109164,8 +110813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: true content: @@ -109187,9 +110836,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: triggersNotification: true githubCloudOnly: false @@ -109216,17 +110865,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109251,9 +110900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 requestBody: required: true content: @@ -109275,9 +110924,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *782 + default: *801 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109302,9 +110951,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 responses: '204': description: Response @@ -109333,9 +110982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -109361,9 +111010,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -109392,9 +111041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *778 - - *431 - - *434 + - *797 + - *448 + - *451 requestBody: required: true content: @@ -109426,9 +111075,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109454,8 +111103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -109481,9 +111130,9 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: - default: *437 + default: *454 headers: Link: *43 x-github: @@ -109512,8 +111161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *778 - - *431 + - *797 + - *448 requestBody: required: true content: @@ -109545,9 +111194,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109571,7 +111220,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -109581,9 +111230,9 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: - default: *340 + default: *358 headers: Link: *43 x-github: @@ -109609,7 +111258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *778 + - *797 - name: role description: Filters members returned by their role in the team. in: query @@ -109632,7 +111281,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '404': *6 @@ -109660,8 +111309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: if user is a member @@ -109697,8 +111346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109737,8 +111386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109774,16 +111423,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '200': description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-user-is-a-team-maintainer: *783 + response-if-user-is-a-team-maintainer: *802 '404': *6 x-github: githubCloudOnly: false @@ -109816,8 +111465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 requestBody: required: false content: @@ -109842,9 +111491,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - response-if-users-membership-with-team-is-now-pending: *784 + response-if-users-membership-with-team-is-now-pending: *803 '403': description: Forbidden if team synchronization is set up '422': @@ -109878,8 +111527,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *778 - - *182 + - *797 + - *198 responses: '204': description: Response @@ -109907,7 +111556,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -109917,9 +111566,9 @@ paths: application/json: schema: type: array - items: *444 + items: *461 examples: - default: *785 + default: *804 headers: Link: *43 '404': *6 @@ -109945,16 +111594,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *778 - - *445 + - *797 + - *462 responses: '200': description: Response content: application/json: - schema: *444 + schema: *461 examples: - default: *786 + default: *805 '404': description: Not Found if project is not managed by this team x-github: @@ -109978,8 +111627,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *778 - - *445 + - *797 + - *462 requestBody: required: false content: @@ -110046,8 +111695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *778 - - *445 + - *797 + - *462 responses: '204': description: Response @@ -110074,7 +111723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -110084,9 +111733,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '404': *6 @@ -110116,15 +111765,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *787 + schema: *806 examples: alternative-response-with-extra-repository-information: value: @@ -110275,9 +111924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 requestBody: required: false content: @@ -110327,9 +111976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *778 - - *446 - - *447 + - *797 + - *463 + - *464 responses: '204': description: Response @@ -110358,15 +112007,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *778 + - *797 responses: '200': description: Response content: application/json: - schema: *448 + schema: *465 examples: - default: *449 + default: *466 '403': *29 '404': *6 x-github: @@ -110393,7 +112042,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *778 + - *797 requestBody: required: true content: @@ -110450,7 +112099,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *465 examples: default: value: @@ -110481,7 +112130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *778 + - *797 - *17 - *19 responses: @@ -110491,9 +112140,9 @@ paths: application/json: schema: type: array - items: *282 + items: *302 examples: - response-if-child-teams-exist: *788 + response-if-child-teams-exist: *807 headers: Link: *43 '404': *6 @@ -110526,7 +112175,7 @@ paths: application/json: schema: oneOf: - - &790 + - &809 title: Private User description: Private User type: object @@ -110729,7 +112378,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *789 + - *808 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -110882,7 +112531,7 @@ paths: description: Response content: application/json: - schema: *790 + schema: *809 examples: default: value: @@ -110961,7 +112610,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 '304': *37 '404': *6 '403': *29 @@ -110984,7 +112633,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *182 + - *198 responses: '204': description: If the user is blocked @@ -111012,7 +112661,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -111036,7 +112685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -111085,9 +112734,9 @@ paths: type: integer codespaces: type: array - items: *347 + items: *365 examples: - default: *348 + default: *366 '304': *37 '500': *40 '401': *25 @@ -111226,21 +112875,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111280,7 +112929,7 @@ paths: type: integer secrets: type: array - items: &791 + items: &810 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -111320,7 +112969,7 @@ paths: - visibility - selected_repositories_url examples: - default: *556 + default: *573 headers: Link: *43 x-github: @@ -111390,13 +113039,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 responses: '200': description: Response content: application/json: - schema: *791 + schema: *810 examples: default: value: @@ -111426,7 +113075,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 requestBody: required: true content: @@ -111471,7 +113120,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -111499,7 +113148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *265 + - *285 responses: '204': description: Response @@ -111524,7 +113173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *265 + - *285 responses: '200': description: Response @@ -111540,9 +113189,9 @@ paths: type: integer repositories: type: array - items: *255 + items: *275 examples: - default: *792 + default: *811 '401': *25 '403': *29 '404': *6 @@ -111567,7 +113216,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *265 + - *285 requestBody: required: true content: @@ -111621,7 +113270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *265 + - *285 - name: repository_id in: path required: true @@ -111654,7 +113303,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *265 + - *285 - name: repository_id in: path required: true @@ -111686,15 +113335,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '304': *37 '500': *40 '401': *25 @@ -111720,7 +113369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 requestBody: required: false content: @@ -111750,9 +113399,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '401': *25 '403': *29 '404': *6 @@ -111774,7 +113423,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '202': *39 '304': *37 @@ -111803,13 +113452,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '202': description: Response content: application/json: - schema: &793 + schema: &812 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -111850,7 +113499,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &794 + default: &813 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -111882,7 +113531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *349 + - *367 - name: export_id in: path required: true @@ -111895,9 +113544,9 @@ paths: description: Response content: application/json: - schema: *793 + schema: *812 examples: - default: *794 + default: *813 '404': *6 x-github: githubCloudOnly: false @@ -111918,7 +113567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *349 + - *367 responses: '200': description: Response @@ -111934,9 +113583,9 @@ paths: type: integer machines: type: array - items: *795 + items: *814 examples: - default: *796 + default: *815 '304': *37 '500': *40 '401': *25 @@ -111965,7 +113614,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *349 + - *367 requestBody: required: true content: @@ -112015,13 +113664,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *459 + repository: *476 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *554 - required: *555 + properties: *571 + required: *572 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -112795,15 +114444,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '304': *37 '500': *40 '400': *14 @@ -112815,7 +114464,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *109 + '409': *114 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112835,15 +114484,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *349 + - *367 responses: '200': description: Response content: application/json: - schema: *347 + schema: *365 examples: - default: *553 + default: *570 '500': *40 '401': *25 '403': *29 @@ -112873,9 +114522,9 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: &808 + default: &826 value: - id: 197 name: hello_docker @@ -112976,7 +114625,7 @@ paths: application/json: schema: type: array - items: &797 + items: &816 title: Email description: Email type: object @@ -113041,9 +114690,9 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: - default: &810 + default: &828 value: - email: octocat@github.com verified: true @@ -113118,7 +114767,7 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: default: value: @@ -113228,7 +114877,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '304': *37 @@ -113261,7 +114910,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 '304': *37 @@ -113283,7 +114932,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *182 + - *198 responses: '204': description: if the person is followed by the authenticated user @@ -113313,7 +114962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -113338,7 +114987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *182 + - *198 responses: '204': description: Response @@ -113374,7 +115023,7 @@ paths: application/json: schema: type: array - items: &798 + items: &817 title: GPG Key description: A unique encryption key type: object @@ -113505,7 +115154,7 @@ paths: - subkeys - revoked examples: - default: &824 + default: &842 value: - id: 3 name: Octocat's GPG Key @@ -113590,9 +115239,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *817 examples: - default: &799 + default: &818 value: id: 3 name: Octocat's GPG Key @@ -113649,7 +115298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &800 + - &819 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -113661,9 +115310,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *817 examples: - default: *799 + default: *818 '404': *6 '304': *37 '403': *29 @@ -113686,7 +115335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *800 + - *819 responses: '204': description: Response @@ -113875,9 +115524,9 @@ paths: type: string repositories: type: array - items: *69 + items: *74 examples: - default: *250 + default: *270 headers: Link: *43 '404': *6 @@ -113902,7 +115551,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *249 + - *269 responses: '204': description: Response @@ -113928,7 +115577,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *249 + - *269 responses: '204': description: Response @@ -113962,12 +115611,12 @@ paths: application/json: schema: anyOf: - - *337 + - *355 - type: object properties: {} additionalProperties: false examples: - default: *338 + default: *356 '204': description: Response when there are no restrictions x-github: @@ -113991,7 +115640,7 @@ paths: required: true content: application/json: - schema: *635 + schema: *652 examples: default: value: @@ -114002,7 +115651,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *355 examples: default: value: @@ -114083,7 +115732,7 @@ paths: - closed - all default: open - - *345 + - *363 - name: sort description: What to sort results by. in: query @@ -114095,8 +115744,8 @@ paths: - updated - comments default: created - - *101 - - *196 + - *106 + - *213 - *17 - *19 responses: @@ -114106,9 +115755,9 @@ paths: application/json: schema: type: array - items: *189 + items: *206 examples: - default: *346 + default: *364 headers: Link: *43 '404': *6 @@ -114141,7 +115790,7 @@ paths: application/json: schema: type: array - items: &801 + items: &820 title: Key description: Key type: object @@ -114242,9 +115891,9 @@ paths: description: Response content: application/json: - schema: *801 + schema: *820 examples: - default: &802 + default: &821 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -114277,15 +115926,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *663 + - *680 responses: '200': description: Response content: application/json: - schema: *801 + schema: *820 examples: - default: *802 + default: *821 '404': *6 '304': *37 '403': *29 @@ -114308,7 +115957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *663 + - *680 responses: '204': description: Response @@ -114341,7 +115990,7 @@ paths: application/json: schema: type: array - items: &803 + items: &822 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114398,7 +116047,7 @@ paths: - id - type - login - plan: *207 + plan: *224 required: - billing_cycle - next_billing_date @@ -114409,7 +116058,7 @@ paths: - account - plan examples: - default: &804 + default: &823 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114471,9 +116120,9 @@ paths: application/json: schema: type: array - items: *803 + items: *822 examples: - default: *804 + default: *823 headers: Link: *43 '304': *37 @@ -114513,7 +116162,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -114615,13 +116264,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *78 + - *83 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -114679,7 +116328,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *78 + - *83 requestBody: required: true content: @@ -114704,7 +116353,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -114772,7 +116421,7 @@ paths: application/json: schema: type: array - items: *352 + items: *370 examples: default: value: @@ -115025,7 +116674,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -115205,7 +116854,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *353 + - *371 - name: exclude in: query required: false @@ -115218,7 +116867,7 @@ paths: description: Response content: application/json: - schema: *352 + schema: *370 examples: default: value: @@ -115412,7 +117061,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *353 + - *371 responses: '302': description: Response @@ -115438,7 +117087,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *353 + - *371 responses: '204': description: Response @@ -115467,8 +117116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *353 - - *805 + - *371 + - *824 responses: '204': description: Response @@ -115492,7 +117141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *353 + - *371 - *17 - *19 responses: @@ -115502,9 +117151,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '404': *6 @@ -115539,9 +117188,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: *806 + default: *237 headers: Link: *43 '304': *37 @@ -115583,7 +117232,7 @@ paths: - docker - nuget - container - - *807 + - *825 - *19 - *17 responses: @@ -115593,10 +117242,10 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 - '400': *809 + default: *826 + '400': *827 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115616,16 +117265,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: - default: &825 + default: &843 value: id: 40201 name: octo-name @@ -115738,8 +117387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 responses: '204': description: Response @@ -115769,8 +117418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 - name: token description: package token schema: @@ -115802,8 +117451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *360 - - *361 + - *378 + - *379 - *19 - *17 - name: state @@ -115823,7 +117472,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -115872,15 +117521,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -115916,9 +117565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '204': description: Response @@ -115948,9 +117597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *360 - - *361 - - *363 + - *378 + - *379 + - *381 responses: '204': description: Response @@ -116006,7 +117655,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *392 examples: default: value: @@ -116078,9 +117727,9 @@ paths: application/json: schema: type: array - items: *797 + items: *816 examples: - default: *810 + default: *828 headers: Link: *43 '304': *37 @@ -116191,9 +117840,9 @@ paths: application/json: schema: type: array - items: *69 + items: *74 examples: - default: &817 + default: &835 summary: Default response value: - id: 1296269 @@ -116497,9 +118146,9 @@ paths: description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *461 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -116537,9 +118186,9 @@ paths: application/json: schema: type: array - items: *637 + items: *654 examples: - default: *811 + default: *829 headers: Link: *43 '304': *37 @@ -116562,12 +118211,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *341 + - *359 responses: '204': description: Response '403': *29 - '409': *109 + '409': *114 '404': *6 '304': *37 x-github: @@ -116585,11 +118234,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *341 + - *359 responses: '204': description: Response - '409': *109 + '409': *114 '304': *37 '404': *6 '403': *29 @@ -116618,7 +118267,7 @@ paths: application/json: schema: type: array - items: &812 + items: &830 title: Social account description: Social media account type: object @@ -116633,7 +118282,7 @@ paths: - provider - url examples: - default: &813 + default: &831 value: - provider: twitter url: https://twitter.com/github @@ -116695,9 +118344,9 @@ paths: application/json: schema: type: array - items: *812 + items: *830 examples: - default: *813 + default: *831 '422': *15 '304': *37 '404': *6 @@ -116784,7 +118433,7 @@ paths: application/json: schema: type: array - items: &814 + items: &832 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -116804,7 +118453,7 @@ paths: - title - created_at examples: - default: &828 + default: &846 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116870,9 +118519,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *832 examples: - default: &815 + default: &833 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116903,7 +118552,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &816 + - &834 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -116915,9 +118564,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *832 examples: - default: *815 + default: *833 '404': *6 '304': *37 '403': *29 @@ -116940,7 +118589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *816 + - *834 responses: '204': description: Response @@ -116969,7 +118618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &829 + - &847 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -116982,7 +118631,7 @@ paths: - created - updated default: created - - *101 + - *106 - *17 - *19 responses: @@ -116992,13 +118641,13 @@ paths: application/json: schema: type: array - items: *69 + items: *74 examples: - default-response: *817 + default-response: *835 application/vnd.github.v3.star+json: schema: type: array - items: &830 + items: &848 title: Starred Repository description: Starred Repository type: object @@ -117006,7 +118655,7 @@ paths: starred_at: type: string format: date-time - repo: *69 + repo: *74 required: - starred_at - repo @@ -117154,8 +118803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response if this repository is starred by you @@ -117183,8 +118832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -117208,8 +118857,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *446 - - *447 + - *463 + - *464 responses: '204': description: Response @@ -117242,9 +118891,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 '304': *37 @@ -117281,7 +118930,7 @@ paths: application/json: schema: type: array - items: *427 + items: *444 examples: default: value: @@ -117359,7 +119008,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *209 + - *226 responses: '200': description: Response @@ -117367,10 +119016,10 @@ paths: application/json: schema: oneOf: - - *790 - - *789 + - *809 + - *808 examples: - default-response: &819 + default-response: &837 summary: Default response value: login: octocat @@ -117405,7 +119054,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &820 + response-with-git-hub-plan-information: &838 summary: Response with GitHub plan information value: login: octocat @@ -117465,7 +119114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *818 + - *836 - *17 responses: '200': @@ -117476,7 +119125,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: example: ; rel="next" @@ -117506,7 +119155,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *182 + - *198 responses: '200': description: Response @@ -117514,11 +119163,11 @@ paths: application/json: schema: oneOf: - - *790 - - *789 + - *809 + - *808 examples: - default-response: *819 - response-with-git-hub-plan-information: *820 + default-response: *837 + response-with-git-hub-plan-information: *838 '404': *6 x-github: githubCloudOnly: false @@ -117542,9 +119191,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *99 - - *100 - - *182 + - *104 + - *105 + - *198 requestBody: required: true content: @@ -117567,8 +119216,8 @@ paths: required: - subject_digests examples: - default: *821 - withPredicateType: *822 + default: *839 + withPredicateType: *840 responses: '200': description: Response @@ -117621,7 +119270,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *823 + default: *841 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -117639,7 +119288,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *182 + - *198 requestBody: required: true content: @@ -117704,7 +119353,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *182 + - *198 - name: subject_digest description: Subject Digest in: path @@ -117735,7 +119384,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *182 + - *198 - name: attestation_id description: Attestation ID in: path @@ -117771,9 +119420,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *99 - - *100 - - *182 + - *104 + - *105 + - *198 - name: subject_digest description: Subject Digest in: path @@ -117825,12 +119474,12 @@ paths: initiator: type: string examples: - default: *499 + default: *516 '201': description: Response content: application/json: - schema: *266 + schema: *286 examples: default: value: @@ -117856,7 +119505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *182 + - *198 responses: '200': description: Response @@ -117864,9 +119513,9 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 + default: *826 '403': *29 '401': *25 x-github: @@ -117889,7 +119538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -117899,7 +119548,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -117961,8 +119610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *182 - - *78 + - *198 + - *83 - *17 - *19 responses: @@ -117972,7 +119621,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -118049,7 +119698,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118059,7 +119708,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -118117,7 +119766,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118129,7 +119778,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -118148,7 +119797,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118160,7 +119809,7 @@ paths: type: array items: *4 examples: - default: *181 + default: *197 headers: Link: *43 x-github: @@ -118179,7 +119828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *182 + - *198 - name: target_user in: path required: true @@ -118206,8 +119855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *182 - - *196 + - *198 + - *213 - *17 - *19 responses: @@ -118217,9 +119866,9 @@ paths: application/json: schema: type: array - items: *197 + items: *214 examples: - default: *198 + default: *215 headers: Link: *43 '422': *15 @@ -118240,7 +119889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118250,9 +119899,9 @@ paths: application/json: schema: type: array - items: *798 + items: *817 examples: - default: *824 + default: *842 headers: Link: *43 x-github: @@ -118276,7 +119925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *182 + - *198 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -118348,7 +119997,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *182 + - *198 responses: '200': description: Response @@ -118356,7 +120005,7 @@ paths: application/json: schema: *22 examples: - default: *634 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118374,7 +120023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118429,7 +120078,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -118439,9 +120088,9 @@ paths: application/json: schema: type: array - items: *64 + items: *69 examples: - default: *806 + default: *237 headers: Link: *43 x-github: @@ -118480,8 +120129,8 @@ paths: - docker - nuget - container - - *807 - - *182 + - *825 + - *198 - *19 - *17 responses: @@ -118491,12 +120140,12 @@ paths: application/json: schema: type: array - items: *358 + items: *376 examples: - default: *808 + default: *826 '403': *29 '401': *25 - '400': *809 + '400': *827 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118516,17 +120165,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '200': description: Response content: application/json: - schema: *358 + schema: *376 examples: - default: *825 + default: *843 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118547,9 +120196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '204': description: Response @@ -118581,9 +120230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 - name: token description: package token schema: @@ -118615,9 +120264,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *360 - - *361 - - *182 + - *378 + - *379 + - *198 responses: '200': description: Response @@ -118625,7 +120274,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -118683,16 +120332,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *360 - - *361 - - *363 - - *182 + - *378 + - *379 + - *381 + - *198 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -118727,10 +120376,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *360 - - *361 - - *182 - - *363 + - *378 + - *379 + - *198 + - *381 responses: '204': description: Response @@ -118762,10 +120411,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *360 - - *361 - - *182 - - *363 + - *378 + - *379 + - *198 + - *381 responses: '204': description: Response @@ -118791,7 +120440,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *182 + - *198 - name: state description: Indicates the state of the projects to return. in: query @@ -118812,7 +120461,7 @@ paths: application/json: schema: type: array - items: *374 + items: *392 examples: default: value: @@ -118870,15 +120519,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *182 + - *198 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *99 - - *100 + - *104 + - *105 - *17 responses: '200': @@ -118887,9 +120536,9 @@ paths: application/json: schema: type: array - items: *375 + items: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -118911,16 +120560,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *377 - - *182 + - *395 + - *198 responses: '200': description: Response content: application/json: - schema: *375 + schema: *393 examples: - default: *376 + default: *394 headers: Link: *43 '304': *37 @@ -118942,11 +120591,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *377 - - *182 + - *395 + - *198 - *17 - - *99 - - *100 + - *104 + - *105 responses: '200': description: Response @@ -118954,9 +120603,9 @@ paths: application/json: schema: type: array - items: *378 + items: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -118978,17 +120627,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *377 - - *826 - - *182 + - *395 + - *844 + - *198 responses: '200': description: Response content: application/json: - schema: *378 + schema: *396 examples: - default: *379 + default: *397 headers: Link: *43 '304': *37 @@ -119011,10 +120660,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *377 - - *182 - - *99 - - *100 + - *395 + - *198 + - *104 + - *105 - *17 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -119024,16 +120673,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -119041,9 +120693,9 @@ paths: application/json: schema: type: array - items: *385 + items: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -119064,8 +120716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *182 - - *377 + - *198 + - *395 requestBody: required: true description: Details of the item to add to the project. @@ -119102,10 +120754,10 @@ paths: description: Response content: application/json: - schema: *827 + schema: *845 examples: - issue: *384 - pull_request: *384 + issue: *402 + pull_request: *402 '304': *37 '403': *29 '401': *25 @@ -119125,28 +120777,31 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *385 + schema: *403 examples: - default: *386 + default: *404 headers: Link: *43 '304': *37 @@ -119167,9 +120822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -119239,13 +120894,13 @@ paths: description: Response content: application/json: - schema: *385 + schema: *403 examples: - text_field: *386 - number_field: *386 - date_field: *386 - single_select_field: *386 - iteration_field: *386 + text_field: *404 + number_field: *404 + date_field: *404 + single_select_field: *404 + iteration_field: *404 '401': *25 '403': *29 '404': *6 @@ -119265,9 +120920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *377 - - *182 - - *387 + - *395 + - *198 + - *405 responses: '204': description: Response @@ -119294,7 +120949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119304,7 +120959,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -119369,7 +121024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119379,7 +121034,7 @@ paths: application/json: schema: type: array - items: *215 + items: *232 examples: default: value: @@ -119442,7 +121097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *182 + - *198 - name: type description: Limit results to repositories of the specified type. in: query @@ -119485,9 +121140,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -119511,15 +121166,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *414 + schema: *431 examples: - default: *415 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119541,15 +121196,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119558,7 +121213,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -119566,12 +121224,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - - *182 - - *173 - - *222 - - *174 - - *224 - - *225 + - *198 + - *189 + - *240 + - *190 + - *242 + - *243 responses: '200': description: Response when getting a billing premium request usage report @@ -119624,19 +121282,19 @@ paths: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -119679,7 +121337,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119701,15 +121359,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *182 + - *198 responses: '200': description: Response content: application/json: - schema: *421 + schema: *438 examples: - default: *422 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119729,11 +121387,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *182 - - *173 - - *226 - - *174 - - *227 + - *198 + - *189 + - *244 + - *190 + - *245 responses: '200': description: Response when getting a billing usage report @@ -119804,7 +121462,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *167 + '503': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119822,7 +121480,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119832,9 +121490,9 @@ paths: application/json: schema: type: array - items: *812 + items: *830 examples: - default: *813 + default: *831 headers: Link: *43 x-github: @@ -119854,7 +121512,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119864,9 +121522,9 @@ paths: application/json: schema: type: array - items: *814 + items: *832 examples: - default: *828 + default: *846 headers: Link: *43 x-github: @@ -119890,9 +121548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *182 - - *829 - - *101 + - *198 + - *847 + - *106 - *17 - *19 responses: @@ -119903,11 +121561,11 @@ paths: schema: anyOf: - type: array - items: *830 + items: *848 - type: array - items: *69 + items: *74 examples: - default-response: *817 + default-response: *835 headers: Link: *43 x-github: @@ -119926,7 +121584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *182 + - *198 - *17 - *19 responses: @@ -119936,9 +121594,9 @@ paths: application/json: schema: type: array - items: *255 + items: *275 examples: - default: *364 + default: *382 headers: Link: *43 x-github: @@ -120066,7 +121724,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &831 + enterprise: &849 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -120124,7 +121782,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &832 + installation: &850 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -120143,7 +121801,7 @@ x-webhooks: required: - id - node_id - organization: &833 + organization: &851 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -120203,13 +121861,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &834 + repository: &852 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &871 + properties: &889 id: description: Unique identifier of the repository example: 42 @@ -120229,8 +121887,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *192 - required: *193 + properties: *209 + required: *210 nullable: true organization: title: Simple User @@ -120892,7 +122550,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &872 + required: &890 - archive_url - assignees_url - blobs_url @@ -121043,10 +122701,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -121122,11 +122780,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: &835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: &853 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -121349,11 +123007,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: *835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: *853 sender: *4 required: - action @@ -121536,11 +123194,11 @@ x-webhooks: - everyone required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - rule: *835 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + rule: *853 sender: *4 required: - action @@ -121611,7 +123269,7 @@ x-webhooks: required: true content: application/json: - schema: &838 + schema: &856 title: Exemption request cancellation event type: object properties: @@ -121619,11 +123277,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: &836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: &854 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -121856,7 +123514,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &837 + items: &855 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -121964,7 +123622,7 @@ x-webhooks: required: true content: application/json: - schema: &839 + schema: &857 title: Exemption request completed event type: object properties: @@ -121972,11 +123630,11 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 sender: *4 required: - action @@ -122046,7 +123704,7 @@ x-webhooks: required: true content: application/json: - schema: &840 + schema: &858 title: Exemption request created event type: object properties: @@ -122054,11 +123712,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 sender: *4 required: - action @@ -122128,7 +123786,7 @@ x-webhooks: required: true content: application/json: - schema: &841 + schema: &859 title: Exemption response dismissed event type: object properties: @@ -122136,12 +123794,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 - exemption_response: *837 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 + exemption_response: *855 sender: *4 required: - action @@ -122213,7 +123871,7 @@ x-webhooks: required: true content: application/json: - schema: &842 + schema: &860 title: Exemption response submitted event type: object properties: @@ -122221,12 +123879,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - exemption_request: *836 - exemption_response: *837 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + exemption_request: *854 + exemption_response: *855 sender: *4 required: - action @@ -122299,7 +123957,7 @@ x-webhooks: required: true content: application/json: - schema: *838 + schema: *856 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122366,7 +124024,7 @@ x-webhooks: required: true content: application/json: - schema: *839 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122433,7 +124091,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122500,7 +124158,7 @@ x-webhooks: required: true content: application/json: - schema: *841 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122568,7 +124226,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -122646,7 +124304,7 @@ x-webhooks: type: string enum: - completed - check_run: &844 + check_run: &862 title: CheckRun description: A check performed on the code of a given code change type: object @@ -122699,8 +124357,8 @@ x-webhooks: type: string pull_requests: type: array - items: *194 - repository: *255 + items: *211 + repository: *275 status: example: completed type: string @@ -122737,7 +124395,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *843 + deployment: *861 details_url: example: https://example.com type: string @@ -122787,7 +124445,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *194 + items: *211 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -122822,10 +124480,10 @@ x-webhooks: - output - app - pull_requests - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -123218,11 +124876,11 @@ x-webhooks: type: string enum: - created - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -123618,11 +125276,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 requested_action: description: The action requested by the user. type: object @@ -124027,11 +125685,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *844 - installation: *832 - enterprise: *831 - organization: *833 - repository: *834 + check_run: *862 + installation: *850 + enterprise: *849 + organization: *851 + repository: *852 sender: *4 required: - check_run @@ -125008,10 +126666,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -125681,10 +127339,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -126348,10 +128006,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -126517,7 +128175,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126662,20 +128320,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &845 + commit_oid: &863 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *831 - installation: *832 - organization: *833 - ref: &846 + enterprise: *849 + installation: *850 + organization: *851 + ref: &864 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -126840,7 +128498,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127070,12 +128728,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127170,7 +128828,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127341,12 +128999,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127512,7 +129170,7 @@ x-webhooks: required: - login - id - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127678,12 +129336,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -127783,7 +129441,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127951,16 +129609,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *834 + repository: *852 sender: *4 required: - action @@ -128057,7 +129715,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *528 + dismissed_comment: *545 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128197,12 +129855,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *845 - enterprise: *831 - installation: *832 - organization: *833 - ref: *846 - repository: *834 + commit_oid: *863 + enterprise: *849 + installation: *850 + organization: *851 + ref: *864 + repository: *852 sender: *4 required: - action @@ -128459,10 +130117,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -128542,18 +130200,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *833 - pusher_type: &847 + organization: *851 + pusher_type: &865 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &848 + ref: &866 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -128563,7 +130221,7 @@ x-webhooks: enum: - tag - branch - repository: *834 + repository: *852 sender: *4 required: - ref @@ -128645,10 +130303,10 @@ x-webhooks: type: string enum: - created - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128733,9 +130391,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128812,10 +130470,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128892,10 +130550,10 @@ x-webhooks: type: string enum: - updated - definition: *129 - enterprise: *831 - installation: *832 - organization: *833 + definition: *145 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -128972,19 +130630,19 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - repository: *834 - organization: *833 + enterprise: *849 + installation: *850 + repository: *852 + organization: *851 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *389 + items: *144 old_property_values: type: array description: The old custom property values for the repository. - items: *389 + items: *144 required: - action - repository @@ -129060,18 +130718,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - pusher_type: *847 - ref: *848 + enterprise: *849 + installation: *850 + organization: *851 + pusher_type: *865 + ref: *866 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *834 + repository: *852 sender: *4 required: - ref @@ -129155,11 +130813,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129243,11 +130901,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129331,11 +130989,11 @@ x-webhooks: type: string enum: - created - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129417,11 +131075,11 @@ x-webhooks: type: string enum: - dismissed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129503,11 +131161,11 @@ x-webhooks: type: string enum: - fixed - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129590,11 +131248,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129676,11 +131334,11 @@ x-webhooks: type: string enum: - reopened - alert: *584 - installation: *832 - organization: *833 - enterprise: *831 - repository: *834 + alert: *601 + installation: *850 + organization: *851 + enterprise: *849 + repository: *852 sender: *4 required: - action @@ -129757,9 +131415,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - key: &849 + enterprise: *849 + installation: *850 + key: &867 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -129795,8 +131453,8 @@ x-webhooks: - verified - created_at - read_only - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -129873,11 +131531,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - key: *849 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + key: *867 + organization: *851 + repository: *852 sender: *4 required: - action @@ -130438,12 +132096,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: &853 + workflow: &871 title: Workflow type: object nullable: true @@ -131169,13 +132827,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *590 + deployment: *607 pull_requests: type: array - items: *682 - repository: *834 - organization: *833 - installation: *832 + items: *701 + repository: *852 + organization: *851 + installation: *850 sender: *4 responses: '200': @@ -131246,7 +132904,7 @@ x-webhooks: type: string enum: - approved - approver: &850 + approver: &868 type: object properties: avatar_url: @@ -131289,11 +132947,11 @@ x-webhooks: type: string comment: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - reviewers: &851 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + reviewers: &869 type: array items: type: object @@ -131372,7 +133030,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &852 + workflow_job_run: &870 type: object properties: conclusion: @@ -132103,18 +133761,18 @@ x-webhooks: type: string enum: - rejected - approver: *850 + approver: *868 comment: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - reviewers: *851 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + reviewers: *869 sender: *4 since: type: string - workflow_job_run: *852 + workflow_job_run: *870 workflow_job_runs: type: array items: @@ -132818,13 +134476,13 @@ x-webhooks: type: string enum: - requested - enterprise: *831 + enterprise: *849 environment: type: string - installation: *832 - organization: *833 - repository: *834 - requestor: &858 + installation: *850 + organization: *851 + repository: *852 + requestor: &876 title: User type: object nullable: true @@ -134723,12 +136381,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Deployment Workflow Run type: object @@ -135408,7 +137066,7 @@ x-webhooks: type: string enum: - answered - answer: &856 + answer: &874 type: object properties: author_association: @@ -135565,11 +137223,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135696,11 +137354,11 @@ x-webhooks: - from required: - category - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135783,11 +137441,11 @@ x-webhooks: type: string enum: - closed - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -135869,7 +137527,7 @@ x-webhooks: type: string enum: - created - comment: &855 + comment: &873 type: object properties: author_association: @@ -136026,11 +137684,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136113,12 +137771,12 @@ x-webhooks: type: string enum: - deleted - comment: *855 - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + comment: *873 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136213,12 +137871,12 @@ x-webhooks: - from required: - body - comment: *855 - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + comment: *873 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136302,11 +137960,11 @@ x-webhooks: type: string enum: - created - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136388,11 +138046,11 @@ x-webhooks: type: string enum: - deleted - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136492,11 +138150,11 @@ x-webhooks: type: string required: - from - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136578,10 +138236,10 @@ x-webhooks: type: string enum: - labeled - discussion: *854 - enterprise: *831 - installation: *832 - label: &857 + discussion: *872 + enterprise: *849 + installation: *850 + label: &875 title: Label type: object properties: @@ -136613,8 +138271,8 @@ x-webhooks: - color - default - description - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136697,11 +138355,11 @@ x-webhooks: type: string enum: - locked - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136783,11 +138441,11 @@ x-webhooks: type: string enum: - pinned - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136869,11 +138527,11 @@ x-webhooks: type: string enum: - reopened - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -136958,16 +138616,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *854 - new_repository: *834 + new_discussion: *872 + new_repository: *852 required: - new_discussion - new_repository - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137050,10 +138708,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *854 - old_answer: *856 - organization: *833 - repository: *834 + discussion: *872 + old_answer: *874 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137135,12 +138793,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *854 - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137223,11 +138881,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137309,11 +138967,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *854 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + discussion: *872 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -137382,7 +139040,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137445,7 +139103,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137511,7 +139169,7 @@ x-webhooks: required: true content: application/json: - schema: *838 + schema: *856 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137577,7 +139235,7 @@ x-webhooks: required: true content: application/json: - schema: *839 + schema: *857 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137643,7 +139301,7 @@ x-webhooks: required: true content: application/json: - schema: *840 + schema: *858 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137709,7 +139367,7 @@ x-webhooks: required: true content: application/json: - schema: *841 + schema: *859 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137775,7 +139433,7 @@ x-webhooks: required: true content: application/json: - schema: *842 + schema: *860 responses: '200': description: Return a 200 status to indicate that the data was received @@ -137842,7 +139500,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *831 + enterprise: *849 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -138502,9 +140160,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *832 - organization: *833 - repository: *834 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - forkee @@ -138650,9 +140308,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pages: description: The pages that were updated. type: array @@ -138689,7 +140347,7 @@ x-webhooks: - action - sha - html_url - repository: *834 + repository: *852 sender: *4 required: - pages @@ -138765,10 +140423,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: &859 + organization: *851 + repositories: &877 description: An array of repository objects that the installation can access. type: array @@ -138794,8 +140452,8 @@ x-webhooks: - name - full_name - private - repository: *834 - requester: *858 + repository: *852 + requester: *876 sender: *4 required: - action @@ -138870,11 +140528,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -138950,11 +140608,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139030,10 +140688,10 @@ x-webhooks: type: string enum: - added - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories_added: &860 + organization: *851 + repositories_added: &878 description: An array of repository objects, which were added to the installation. type: array @@ -139079,15 +140737,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *834 - repository_selection: &861 + repository: *852 + repository_selection: &879 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *858 + requester: *876 sender: *4 required: - action @@ -139166,10 +140824,10 @@ x-webhooks: type: string enum: - removed - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories_added: *860 + organization: *851 + repositories_added: *878 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -139196,9 +140854,9 @@ x-webhooks: - name - full_name - private - repository: *834 - repository_selection: *861 - requester: *858 + repository: *852 + repository_selection: *879 + requester: *876 sender: *4 required: - action @@ -139277,11 +140935,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139460,10 +141118,10 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 target_type: type: string @@ -139542,11 +141200,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *831 + enterprise: *849 installation: *22 - organization: *833 - repositories: *859 - repository: *834 + organization: *851 + repositories: *877 + repository: *852 requester: nullable: true sender: *4 @@ -139670,8 +141328,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *186 - required: *187 + properties: *203 + required: *204 reactions: title: Reactions type: object @@ -139798,8 +141456,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -140593,8 +142251,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140610,7 +142268,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -140943,8 +142601,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -141024,7 +142682,7 @@ x-webhooks: type: string enum: - deleted - comment: &862 + comment: &880 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -141189,8 +142847,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -141980,8 +143638,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141997,7 +143655,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -142332,8 +143990,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -142413,7 +144071,7 @@ x-webhooks: type: string enum: - edited - changes: &891 + changes: &909 description: The changes to the comment. type: object properties: @@ -142425,9 +144083,9 @@ x-webhooks: type: string required: - from - comment: *862 - enterprise: *831 - installation: *832 + comment: *880 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143220,8 +144878,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143237,7 +144895,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -143570,8 +145228,8 @@ x-webhooks: - state - locked - assignee - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143655,15 +145313,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 + blocked_issue: *206 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - blocking_issue_repo: *69 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + blocking_issue_repo: *74 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143751,15 +145409,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 + blocked_issue: *206 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - blocking_issue_repo: *69 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + blocking_issue_repo: *74 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143846,15 +145504,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 - blocked_issue_repo: *69 + blocked_issue: *206 + blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -143942,15 +145600,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *189 - blocked_issue_repo: *69 + blocked_issue: *206 + blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *189 - installation: *832 - organization: *833 - repository: *834 + blocking_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -144035,10 +145693,10 @@ x-webhooks: type: string enum: - assigned - assignee: *858 - enterprise: *831 - installation: *832 - issue: &865 + assignee: *876 + enterprise: *849 + installation: *850 + issue: &883 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -144827,11 +146485,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144847,7 +146505,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -144948,8 +146606,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -145029,8 +146687,8 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -145824,11 +147482,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145844,7 +147502,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -146080,8 +147738,8 @@ x-webhooks: required: - state - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -146160,8 +147818,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -146946,11 +148604,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146966,7 +148624,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -147066,8 +148724,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -147146,8 +148804,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147954,11 +149612,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147974,7 +149632,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -148053,7 +149711,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &863 + milestone: &881 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148191,8 +149849,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -148291,8 +149949,8 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149081,11 +150739,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149098,7 +150756,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -149202,9 +150860,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *857 - organization: *833 - repository: *834 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -149284,8 +150942,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150073,11 +151731,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150090,7 +151748,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -150194,9 +151852,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *857 - organization: *833 - repository: *834 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -150276,8 +151934,8 @@ x-webhooks: type: string enum: - locked - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151089,11 +152747,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151106,7 +152764,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *342 + type: *360 title: description: Title of the issue type: string @@ -151187,8 +152845,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -151267,8 +152925,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152074,11 +153732,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152094,7 +153752,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -152172,9 +153830,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *863 - organization: *833 - repository: *834 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -153042,11 +154700,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153139,7 +154797,7 @@ x-webhooks: required: - login - id - type: *342 + type: *360 required: - id - number @@ -153608,8 +155266,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154398,11 +156056,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154418,7 +156076,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -154518,8 +156176,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -154599,9 +156257,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *831 - installation: *832 - issue: &864 + enterprise: *849 + installation: *850 + issue: &882 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -155384,11 +157042,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155404,7 +157062,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -155504,8 +157162,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -155584,8 +157242,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156395,11 +158053,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156493,9 +158151,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *342 - organization: *833 - repository: *834 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -157361,11 +159019,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157381,7 +159039,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -157949,11 +159607,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *831 - installation: *832 - issue: *864 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *882 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158033,12 +159691,12 @@ x-webhooks: type: string enum: - typed - enterprise: *831 - installation: *832 - issue: *865 - type: *342 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158119,7 +159777,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &894 + assignee: &912 title: User type: object nullable: true @@ -158189,11 +159847,11 @@ x-webhooks: required: - login - id - enterprise: *831 - installation: *832 - issue: *865 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158272,12 +159930,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *831 - installation: *832 - issue: *865 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -158357,8 +160015,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159168,11 +160826,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *775 - issue_dependencies_summary: *776 + sub_issues_summary: *794 + issue_dependencies_summary: *795 issue_field_values: type: array - items: *777 + items: *796 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159188,7 +160846,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *342 + type: *360 updated_at: type: string format: date-time @@ -159266,8 +160924,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159347,11 +161005,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *831 - installation: *832 - issue: *864 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *882 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159430,12 +161088,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *831 - installation: *832 - issue: *865 - type: *342 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + issue: *883 + type: *360 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159515,11 +161173,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159597,11 +161255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159711,11 +161369,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - label: *857 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + label: *875 + organization: *851 + repository: *852 sender: *4 required: - action @@ -159797,9 +161455,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: &866 + enterprise: *849 + installation: *850 + marketplace_purchase: &884 title: Marketplace Purchase type: object required: @@ -159882,8 +161540,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *833 - previous_marketplace_purchase: &867 + organization: *851 + previous_marketplace_purchase: &885 title: Marketplace Purchase type: object properties: @@ -159963,7 +161621,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160043,10 +161701,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160129,7 +161787,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160211,10 +161869,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160296,7 +161954,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *834 + repository: *852 sender: *4 required: - action @@ -160377,8 +162035,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 marketplace_purchase: title: Marketplace Purchase type: object @@ -160460,9 +162118,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *833 - previous_marketplace_purchase: *867 - repository: *834 + organization: *851 + previous_marketplace_purchase: *885 + repository: *852 sender: *4 required: - action @@ -160542,12 +162200,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *831 - installation: *832 - marketplace_purchase: *866 - organization: *833 - previous_marketplace_purchase: *867 - repository: *834 + enterprise: *849 + installation: *850 + marketplace_purchase: *884 + organization: *851 + previous_marketplace_purchase: *885 + repository: *852 sender: *4 required: - action @@ -160649,11 +162307,11 @@ x-webhooks: type: string required: - to - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160753,11 +162411,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160836,11 +162494,11 @@ x-webhooks: type: string enum: - removed - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 sender: *4 required: - action @@ -160918,11 +162576,11 @@ x-webhooks: type: string enum: - added - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 scope: description: The scope of the membership. Currently, can only be `team`. @@ -160998,7 +162656,7 @@ x-webhooks: required: - login - id - team: &868 + team: &886 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -161221,11 +162879,11 @@ x-webhooks: type: string enum: - removed - enterprise: *831 - installation: *832 - member: *858 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + member: *876 + organization: *851 + repository: *852 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161302,7 +162960,7 @@ x-webhooks: required: - login - id - team: *868 + team: *886 required: - action - scope @@ -161384,8 +163042,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *832 - merge_group: &870 + installation: *850 + merge_group: &888 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -161404,15 +163062,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *869 + head_commit: *887 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161498,10 +163156,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *832 - merge_group: *870 - organization: *833 - repository: *834 + installation: *850 + merge_group: *888 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161574,7 +163232,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 + enterprise: *849 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -161683,16 +163341,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *832 - organization: *833 + installation: *850 + organization: *851 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -161773,11 +163431,11 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -161856,9 +163514,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - milestone: &873 + enterprise: *849 + installation: *850 + milestone: &891 title: Milestone description: A collection of related issues and pull requests. type: object @@ -161995,8 +163653,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162075,11 +163733,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162189,11 +163847,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - milestone: *863 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *881 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162273,11 +163931,11 @@ x-webhooks: type: string enum: - opened - enterprise: *831 - installation: *832 - milestone: *873 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + milestone: *891 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162356,11 +164014,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *858 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + blocked_user: *876 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162439,11 +164097,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *858 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + blocked_user: *876 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162462,6 +164120,320 @@ x-webhooks: - organization - business - app + organization-custom-property-created: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: A new organization custom property was created. + operationId: organization-custom-property/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: *139 + enterprise: *849 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-deleted: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was deleted. + operationId: organization-custom-property/deleted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + enterprise: *849 + installation: *850 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-updated: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was updated. + operationId: organization-custom-property/updated + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: organization custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: *139 + enterprise: *849 + installation: *850 + sender: *4 + required: + - action + - definition + - enterprise + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-values-updated: + post: + summary: This event occurs when there is activity relating to custom property + values for an organization. + description: The custom property values of an organization were updated. + operationId: organization-custom-property-values/updated + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: *849 + installation: *850 + organization: *851 + sender: *4 + new_property_values: + type: array + description: The new custom property values. + items: *144 + old_property_values: + type: array + description: The old custom property values. + items: *144 + required: + - action + - organization + - enterprise + - new_property_values + - old_property_values + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization-custom-property-values + supported-webhook-types: + - business + - organization + - app organization-deleted: post: summary: |- @@ -162522,9 +164494,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - membership: &874 + enterprise: *849 + installation: *850 + membership: &892 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -162631,8 +164603,8 @@ x-webhooks: - role - organization_url - user - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162710,11 +164682,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -162793,8 +164765,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -162910,10 +164882,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 - user: *858 + user: *876 required: - action - invitation @@ -162991,11 +164963,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -163082,11 +165054,11 @@ x-webhooks: properties: from: type: string - enterprise: *831 - installation: *832 - membership: *874 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + membership: *892 + organization: *851 + repository: *852 sender: *4 required: - action @@ -163162,9 +165134,9 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 package: description: Information about the package. type: object @@ -163663,7 +165635,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &875 + items: &893 title: Ruby Gems metadata type: object properties: @@ -163758,7 +165730,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -163834,9 +165806,9 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 package: description: Information about the package. type: object @@ -164189,7 +166161,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *875 + items: *893 source_url: type: string format: uri @@ -164259,7 +166231,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -164436,12 +166408,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *831 + enterprise: *849 id: type: integer - installation: *832 - organization: *833 - repository: *834 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - id @@ -164518,7 +166490,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &876 + personal_access_token_request: &894 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -164664,10 +166636,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *831 - organization: *833 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164744,11 +166716,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *876 - enterprise: *831 - organization: *833 + personal_access_token_request: *894 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164824,11 +166796,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *876 - enterprise: *831 - organization: *833 + personal_access_token_request: *894 + enterprise: *849 + organization: *851 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -164903,11 +166875,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *876 - organization: *833 - enterprise: *831 + personal_access_token_request: *894 + organization: *851 + enterprise: *849 sender: *4 - installation: *832 + installation: *850 required: - action - personal_access_token_request @@ -165012,7 +166984,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *877 + last_response: *895 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -165044,8 +167016,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 zen: description: Random string of GitHub zen. @@ -165290,10 +167262,10 @@ x-webhooks: - from required: - note - enterprise: *831 - installation: *832 - organization: *833 - project_card: &878 + enterprise: *849 + installation: *850 + organization: *851 + project_card: &896 title: Project Card type: object properties: @@ -165412,7 +167384,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -165493,11 +167465,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project_card: *878 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_card: *896 + repository: *852 sender: *4 required: - action @@ -165577,9 +167549,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 project_card: title: Project Card type: object @@ -165707,8 +167679,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -165802,11 +167774,11 @@ x-webhooks: - from required: - note - enterprise: *831 - installation: *832 - organization: *833 - project_card: *878 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_card: *896 + repository: *852 sender: *4 required: - action @@ -165900,9 +167872,9 @@ x-webhooks: - from required: - column_id - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 project_card: allOf: - title: Project Card @@ -166092,7 +168064,7 @@ x-webhooks: type: string required: - after_id - repository: *834 + repository: *852 sender: *4 required: - action @@ -166172,10 +168144,10 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - organization: *833 - project: &880 + enterprise: *849 + installation: *850 + organization: *851 + project: &898 title: Project type: object properties: @@ -166299,7 +168271,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -166379,10 +168351,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project_column: &879 + enterprise: *849 + installation: *850 + organization: *851 + project_column: &897 title: Project Column type: object properties: @@ -166421,7 +168393,7 @@ x-webhooks: - name - created_at - updated_at - repository: *834 + repository: *852 sender: *4 required: - action @@ -166500,18 +168472,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -166601,11 +168573,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 + repository: *852 sender: *4 required: - action @@ -166685,11 +168657,11 @@ x-webhooks: type: string enum: - moved - enterprise: *831 - installation: *832 - organization: *833 - project_column: *879 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project_column: *897 + repository: *852 sender: *4 required: - action @@ -166769,11 +168741,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -166853,18 +168825,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - project: *880 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *871 - required: *872 + properties: *889 + required: *890 nullable: true sender: *4 required: @@ -166966,11 +168938,11 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -167049,11 +169021,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 - organization: *833 - project: *880 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + project: *898 + repository: *852 sender: *4 required: - action @@ -167134,9 +169106,9 @@ x-webhooks: type: string enum: - closed - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167217,9 +169189,9 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167300,9 +169272,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167419,9 +169391,9 @@ x-webhooks: type: string to: type: string - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -167504,7 +169476,7 @@ x-webhooks: type: string enum: - archived - changes: &884 + changes: &902 type: object properties: archived_at: @@ -167518,9 +169490,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *832 - organization: *833 - projects_v2_item: &881 + installation: *850 + organization: *851 + projects_v2_item: &899 title: Projects v2 Item description: An item belonging to a project type: object @@ -167538,7 +169510,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *383 + content_type: *401 creator: *4 created_at: type: string @@ -167655,9 +169627,9 @@ x-webhooks: nullable: true to: type: string - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167739,9 +169711,9 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167822,9 +169794,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -167930,7 +169902,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &882 + - &900 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -167952,7 +169924,7 @@ x-webhooks: required: - id - name - - &883 + - &901 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -167986,8 +169958,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *882 - - *883 + - *900 + - *901 required: - field_value - type: object @@ -168003,9 +169975,9 @@ x-webhooks: nullable: true required: - body - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168100,9 +170072,9 @@ x-webhooks: to: type: string nullable: true - installation: *832 - organization: *833 - projects_v2_item: *881 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168185,10 +170157,10 @@ x-webhooks: type: string enum: - restored - changes: *884 - installation: *832 - organization: *833 - projects_v2_item: *881 + changes: *902 + installation: *850 + organization: *851 + projects_v2_item: *899 sender: *4 required: - action @@ -168270,9 +170242,9 @@ x-webhooks: type: string enum: - reopened - installation: *832 - organization: *833 - projects_v2: *375 + installation: *850 + organization: *851 + projects_v2: *393 sender: *4 required: - action @@ -168353,14 +170325,14 @@ x-webhooks: type: string enum: - created - installation: *832 - organization: *833 - projects_v2_status_update: &887 + installation: *850 + organization: *851 + projects_v2_status_update: &905 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *885 - required: *886 + properties: *903 + required: *904 sender: *4 required: - action @@ -168441,9 +170413,9 @@ x-webhooks: type: string enum: - deleted - installation: *832 - organization: *833 - projects_v2_status_update: *887 + installation: *850 + organization: *851 + projects_v2_status_update: *905 sender: *4 required: - action @@ -168579,9 +170551,9 @@ x-webhooks: type: string format: date nullable: true - installation: *832 - organization: *833 - projects_v2_status_update: *887 + installation: *850 + organization: *851 + projects_v2_status_update: *905 sender: *4 required: - action @@ -168652,10 +170624,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - repository @@ -168732,13 +170704,13 @@ x-webhooks: type: string enum: - assigned - assignee: *858 - enterprise: *831 - installation: *832 - number: &888 + assignee: *876 + enterprise: *849 + installation: *850 + number: &906 description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -171021,7 +172993,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -171103,11 +173075,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -173385,7 +175357,7 @@ x-webhooks: - draft reason: type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -173467,11 +175439,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -175749,7 +177721,7 @@ x-webhooks: - draft reason: type: string - repository: *834 + repository: *852 sender: *4 required: - action @@ -175831,13 +177803,13 @@ x-webhooks: type: string enum: - closed - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: &889 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: &907 allOf: - - *682 + - *701 - type: object properties: allow_auto_merge: @@ -175899,7 +177871,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *834 + repository: *852 sender: *4 required: - action @@ -175980,12 +177952,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -176065,11 +178037,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *831 - milestone: *666 - number: *888 - organization: *833 - pull_request: &890 + enterprise: *849 + milestone: *683 + number: *906 + organization: *851 + pull_request: &908 title: Pull Request type: object properties: @@ -178332,7 +180304,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -178411,11 +180383,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -180697,7 +182669,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *834 + repository: *852 sender: *4 required: - action @@ -180821,12 +182793,12 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -180906,11 +182878,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -183177,7 +185149,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -183257,11 +185229,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *831 - installation: *832 - label: *857 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + label: *875 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -185543,7 +187515,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -185624,10 +187596,10 @@ x-webhooks: type: string enum: - locked - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -187907,7 +189879,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -187987,12 +189959,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *831 - milestone: *666 - number: *888 - organization: *833 - pull_request: *890 - repository: *834 + enterprise: *849 + milestone: *683 + number: *906 + organization: *851 + pull_request: *908 + repository: *852 sender: *4 required: - action @@ -188071,12 +190043,12 @@ x-webhooks: type: string enum: - opened - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188157,12 +190129,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188242,12 +190214,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *831 - installation: *832 - number: *888 - organization: *833 - pull_request: *889 - repository: *834 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 + pull_request: *907 + repository: *852 sender: *4 required: - action @@ -188613,9 +190585,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -190785,7 +192757,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -190865,7 +192837,7 @@ x-webhooks: type: string enum: - deleted - comment: &892 + comment: &910 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -191150,9 +193122,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -193310,7 +195282,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -193390,11 +195362,11 @@ x-webhooks: type: string enum: - edited - changes: *891 - comment: *892 - enterprise: *831 - installation: *832 - organization: *833 + changes: *909 + comment: *910 + enterprise: *849 + installation: *850 + organization: *851 pull_request: type: object properties: @@ -195555,7 +197527,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *834 + repository: *852 sender: *4 required: - action @@ -195636,9 +197608,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -197811,7 +199783,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 review: description: The review that was affected. type: object @@ -198058,9 +200030,9 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -200114,8 +202086,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 - review: &893 + repository: *852 + review: &911 description: The review that was affected. type: object properties: @@ -200348,12 +202320,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -202636,7 +204608,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_reviewer: title: User type: object @@ -202720,12 +204692,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -205015,7 +206987,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205207,12 +207179,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -207497,7 +209469,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_reviewer: title: User type: object @@ -207582,12 +209554,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *831 - installation: *832 + enterprise: *849 + installation: *850 number: description: The pull request number. type: integer - organization: *833 + organization: *851 pull_request: title: Pull Request type: object @@ -209863,7 +211835,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210044,9 +212016,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -212221,8 +214193,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 - review: *893 + repository: *852 + review: *911 sender: *4 required: - action @@ -212302,9 +214274,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -214374,7 +216346,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 sender: *4 thread: type: object @@ -214761,9 +216733,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 pull_request: title: Simple Pull Request type: object @@ -216819,7 +218791,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *834 + repository: *852 sender: *4 thread: type: object @@ -217209,10 +219181,10 @@ x-webhooks: type: string before: type: string - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -219483,7 +221455,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -219565,11 +221537,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *894 - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + assignee: *912 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -221852,7 +223824,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -221931,11 +223903,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *831 - installation: *832 - label: *857 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + label: *875 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -224208,7 +226180,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -224289,10 +226261,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *831 - installation: *832 - number: *888 - organization: *833 + enterprise: *849 + installation: *850 + number: *906 + organization: *851 pull_request: title: Pull Request type: object @@ -226557,7 +228529,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *834 + repository: *852 sender: *4 required: - action @@ -226757,7 +228729,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *831 + enterprise: *849 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -226849,8 +228821,8 @@ x-webhooks: - url - author - committer - installation: *832 - organization: *833 + installation: *850 + organization: *851 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -227425,9 +229397,9 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 registry_package: type: object properties: @@ -227873,7 +229845,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *875 + items: *893 summary: type: string tag_name: @@ -227927,7 +229899,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -228005,9 +229977,9 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 registry_package: type: object properties: @@ -228315,7 +230287,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *875 + items: *893 summary: type: string tag_name: @@ -228364,7 +230336,7 @@ x-webhooks: - owner - package_version - registry - repository: *834 + repository: *852 sender: *4 required: - action @@ -228441,10 +230413,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - release: &895 + enterprise: *849 + installation: *850 + organization: *851 + release: &913 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -228762,7 +230734,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *834 + repository: *852 sender: *4 required: - action @@ -228839,11 +230811,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -228960,11 +230932,11 @@ x-webhooks: type: boolean required: - to - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -229042,9 +231014,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -229366,7 +231338,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *834 + repository: *852 sender: *4 required: - action @@ -229442,10 +231414,10 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - release: &896 + enterprise: *849 + installation: *850 + organization: *851 + release: &914 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -229764,7 +231736,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *834 + repository: *852 sender: *4 required: - action @@ -229840,11 +231812,11 @@ x-webhooks: type: string enum: - released - enterprise: *831 - installation: *832 - organization: *833 - release: *895 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *913 + repository: *852 sender: *4 required: - action @@ -229920,11 +231892,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *831 - installation: *832 - organization: *833 - release: *896 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + release: *914 + repository: *852 sender: *4 required: - action @@ -230000,11 +231972,11 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_advisory: *735 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_advisory: *754 sender: *4 required: - action @@ -230080,11 +232052,11 @@ x-webhooks: type: string enum: - reported - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_advisory: *735 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_advisory: *754 sender: *4 required: - action @@ -230160,10 +232132,10 @@ x-webhooks: type: string enum: - archived - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230240,10 +232212,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230321,10 +232293,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230408,10 +232380,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230523,10 +232495,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230598,10 +232570,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 status: type: string @@ -230682,10 +232654,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230762,10 +232734,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230859,10 +232831,10 @@ x-webhooks: - name required: - repository - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -230942,11 +232914,11 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 sender: *4 required: - action @@ -231024,11 +232996,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 sender: *4 required: - action @@ -231106,11 +233078,11 @@ x-webhooks: type: string enum: - edited - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - repository_ruleset: *162 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + repository_ruleset: *178 changes: type: object properties: @@ -231129,16 +233101,16 @@ x-webhooks: properties: added: type: array - items: *136 + items: *150 deleted: type: array - items: *136 + items: *150 updated: type: array items: type: object properties: - condition: *136 + condition: *150 changes: type: object properties: @@ -231171,16 +233143,16 @@ x-webhooks: properties: added: type: array - items: *703 + items: *722 deleted: type: array - items: *703 + items: *722 updated: type: array items: type: object properties: - rule: *703 + rule: *722 changes: type: object properties: @@ -231414,10 +233386,10 @@ x-webhooks: - from required: - owner - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231495,10 +233467,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231576,7 +233548,7 @@ x-webhooks: type: string enum: - create - alert: &897 + alert: &915 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -231697,10 +233669,10 @@ x-webhooks: type: string enum: - open - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231906,10 +233878,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -231987,11 +233959,11 @@ x-webhooks: type: string enum: - reopen - alert: *897 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *915 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232190,10 +234162,10 @@ x-webhooks: enum: - fixed - open - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232271,11 +234243,11 @@ x-webhooks: type: string enum: - created - alert: &898 + alert: &916 type: object properties: - number: *113 - created_at: *120 + number: *123 + created_at: *130 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -232283,8 +234255,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *118 - html_url: *119 + url: *128 + html_url: *129 locations_url: type: string format: uri @@ -232389,10 +234361,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232473,11 +234445,11 @@ x-webhooks: type: string enum: - created - alert: *898 - installation: *832 - location: *899 - organization: *833 - repository: *834 + alert: *916 + installation: *850 + location: *917 + organization: *851 + repository: *852 sender: *4 required: - location @@ -232715,11 +234687,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232797,11 +234769,11 @@ x-webhooks: type: string enum: - reopened - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232879,11 +234851,11 @@ x-webhooks: type: string enum: - resolved - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -232961,11 +234933,11 @@ x-webhooks: type: string enum: - validated - alert: *898 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + alert: *916 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -233091,10 +235063,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *834 - enterprise: *831 - installation: *832 - organization: *833 + repository: *852 + enterprise: *849 + installation: *850 + organization: *851 sender: *4 required: - action @@ -233172,11 +235144,11 @@ x-webhooks: type: string enum: - published - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - security_advisory: &900 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + security_advisory: &918 description: The details of the security advisory, including summary, description, and severity. type: object @@ -233192,7 +235164,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array items: @@ -233359,11 +235331,11 @@ x-webhooks: type: string enum: - updated - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 - security_advisory: *900 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 + security_advisory: *918 sender: *4 required: - action @@ -233436,10 +235408,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -233456,7 +235428,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *115 + cvss_severities: *125 cwes: type: array items: @@ -233623,11 +235595,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *392 - enterprise: *831 - installation: *832 - organization: *833 - repository: *459 + security_and_analysis: *409 + enterprise: *849 + installation: *850 + organization: *851 + repository: *476 sender: *4 required: - changes @@ -233705,12 +235677,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: &901 + sponsorship: &919 type: object properties: created_at: @@ -234011,12 +235983,12 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - sponsorship @@ -234104,12 +236076,12 @@ x-webhooks: type: string required: - from - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234186,17 +236158,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &902 + effective_date: &920 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - sponsorship @@ -234270,7 +236242,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &903 + changes: &921 type: object properties: tier: @@ -234314,13 +236286,13 @@ x-webhooks: - from required: - tier - effective_date: *902 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + effective_date: *920 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234397,13 +236369,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *903 - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + changes: *921 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - sponsorship: *901 + sponsorship: *919 required: - action - changes @@ -234477,10 +236449,10 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234563,10 +236535,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234986,15 +236958,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *831 + enterprise: *849 id: description: The unique identifier of the status. type: integer - installation: *832 + installation: *850 name: type: string - organization: *833 - repository: *834 + organization: *851 + repository: *852 sender: *4 sha: description: The Commit SHA. @@ -235103,15 +237075,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - parent_issue_repo: *69 + parent_issue: *206 + parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - installation: *832 - organization: *833 - repository: *834 + sub_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235195,15 +237167,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - parent_issue_repo: *69 + parent_issue: *206 + parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - installation: *832 - organization: *833 - repository: *834 + sub_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235287,15 +237259,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - sub_issue_repo: *69 + sub_issue: *206 + sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - installation: *832 - organization: *833 - repository: *834 + parent_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235379,15 +237351,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *189 - sub_issue_repo: *69 + sub_issue: *206 + sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *189 - installation: *832 - organization: *833 - repository: *834 + parent_issue: *206 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -235464,12 +237436,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - team: &904 + team: &922 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -235692,9 +237664,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -236152,7 +238124,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -236228,9 +238200,9 @@ x-webhooks: type: string enum: - created - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -236688,7 +238660,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -236765,9 +238737,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -237225,7 +239197,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -237369,9 +239341,9 @@ x-webhooks: - from required: - permissions - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -237829,7 +239801,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - changes @@ -237907,9 +239879,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *831 - installation: *832 - organization: *833 + enterprise: *849 + installation: *850 + organization: *851 repository: title: Repository description: A git repository @@ -238367,7 +240339,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *904 + team: *922 required: - action - team @@ -238443,10 +240415,10 @@ x-webhooks: type: string enum: - started - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 required: - action @@ -238519,16 +240491,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *831 + enterprise: *849 inputs: type: object nullable: true additionalProperties: true - installation: *832 - organization: *833 + installation: *850 + organization: *851 ref: type: string - repository: *834 + repository: *852 sender: *4 workflow: type: string @@ -238610,10 +240582,10 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: allOf: @@ -238850,7 +240822,7 @@ x-webhooks: type: string required: - conclusion - deployment: *590 + deployment: *607 required: - action - repository @@ -238929,10 +240901,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: allOf: @@ -239192,7 +241164,7 @@ x-webhooks: required: - status - steps - deployment: *590 + deployment: *607 required: - action - repository @@ -239271,10 +241243,10 @@ x-webhooks: type: string enum: - queued - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: type: object @@ -239409,7 +241381,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *590 + deployment: *607 required: - action - repository @@ -239488,10 +241460,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 workflow_job: type: object @@ -239627,7 +241599,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *590 + deployment: *607 required: - action - repository @@ -239707,12 +241679,12 @@ x-webhooks: type: string enum: - completed - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object @@ -240711,12 +242683,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object @@ -241700,12 +243672,12 @@ x-webhooks: type: string enum: - requested - enterprise: *831 - installation: *832 - organization: *833 - repository: *834 + enterprise: *849 + installation: *850 + organization: *851 + repository: *852 sender: *4 - workflow: *853 + workflow: *871 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 551749c44..96b267093 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -188,6 +188,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -2497,6 +2501,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -2517,6 +2526,11 @@ "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean", "default": false + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -2568,6 +2582,281 @@ } } }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an enterprise", + "description": "List custom images for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get an enterprise custom image definition for GitHub Actions Hosted Runners", + "description": "Get an enterprise custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the enterprise", + "description": "Delete a custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an enterprise", + "description": "List image versions of a custom image for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the enterprise", + "description": "Delete an image version of custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", @@ -2934,6 +3223,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -8667,6 +8961,216 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": { + "get": { + "summary": "Get Copilot enterprise usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": { + "get": { + "summary": "Get Copilot enterprise usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -8716,12 +9220,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -9262,6 +9760,441 @@ } } }, + "/enterprises/{enterprise}/org-properties/schema": { + "get": { + "summary": "Get organization custom properties schema for an enterprise", + "description": "Gets all organization custom property definitions that are defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update organization custom property definitions on an enterprise", + "description": "Creates new or updates existing organization custom properties defined on an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of organization custom properties to create or update.", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": { + "get": { + "summary": "Get an organization custom property definition from an enterprise", + "description": "Gets an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "put": { + "summary": "Create or update an organization custom property definition on an enterprise", + "description": "Creates a new or updates an existing organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property-payload" + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "delete": { + "summary": "Remove an organization custom property definition from an enterprise", + "description": "Removes an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/values": { + "get": { + "summary": "List custom property values for organizations in an enterprise", + "description": "Lists enterprise organizations with all of their custom property values.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-properties-for-orgs-get-enterprise-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties-for-orgs-get-enterprise-property-values" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for organizations in an enterprise", + "description": "Create or update custom property values for organizations in an enterprise.\n\nTo remove a custom property value from an organization, set the property value to `null`.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"edit enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization_logins": { + "type": "array", + "description": "The names of organizations that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the organizations.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "organization_logins", + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties-for-orgs-patch-enterprise-property-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", @@ -10211,7 +11144,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -10518,6 +11451,9 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center-state" } ], "responses": { @@ -11109,7 +12045,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -11475,6 +12411,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -11874,6 +12820,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -11971,6 +13247,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -15395,10 +16681,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -16053,6 +17454,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -16071,6 +17477,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -16123,6 +17534,281 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -16489,6 +18175,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -21009,6 +22700,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -21710,7 +23472,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -21721,8 +23484,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -25482,12 +27256,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -32682,16 +34450,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -32868,16 +34642,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -55472,16 +57252,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -55497,12 +57267,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -73086,7 +74850,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -88519,16 +90283,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -88696,16 +90466,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -89249,7 +91025,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -90382,11 +92158,104 @@ } } }, - "bypass-request-push-ruleset-created": { + "bypass-request-push-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass request was created.", - "operationId": "exemption-request-push-ruleset/created", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, @@ -90453,7 +92322,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -90475,11 +92344,11 @@ } } }, - "bypass-request-push-ruleset-response-dismissed": { + "bypass-request-push-ruleset-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass response was dismissed.", - "operationId": "exemption-request-push-ruleset/response-dismissed", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, @@ -90546,7 +92415,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -90568,13 +92437,13 @@ } } }, - "bypass-request-push-ruleset-response-submitted": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", - "operationId": "exemption-request-push-ruleset/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -90639,7 +92508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -90652,7 +92521,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "bypass_request_push_ruleset", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -90661,11 +92530,11 @@ } } }, - "bypass-request-secret-scanning-cancelled": { + "bypass-request-secret-scanning-completed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass request was cancelled.", - "operationId": "exemption-request-secret-scanning/cancelled", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90732,7 +92601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -90754,11 +92623,11 @@ } } }, - "bypass-request-secret-scanning-completed": { + "bypass-request-secret-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning bypass request was completed.", - "operationId": "exemption-request-secret-scanning/completed", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90825,7 +92694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -90847,11 +92716,11 @@ } } }, - "bypass-request-secret-scanning-created": { + "bypass-request-secret-scanning-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass request was created.", - "operationId": "exemption-request-secret-scanning/created", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90918,7 +92787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -90940,11 +92809,11 @@ } } }, - "bypass-request-secret-scanning-response-dismissed": { + "bypass-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass response was dismissed.", - "operationId": "exemption-request-secret-scanning/response-dismissed", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -91011,7 +92880,224 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-created": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A new check run was created.", + "operationId": "check-run/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -91022,9 +93108,10 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "bypass_request_secret_scanning", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -91033,13 +93120,13 @@ } } }, - "bypass-request-secret-scanning-response-submitted": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", - "operationId": "exemption-request-secret-scanning/response-submitted", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -91104,7 +93191,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -91115,9 +93217,10 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "bypass_request_secret_scanning", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -91126,11 +93229,11 @@ } } }, - "check-run-completed": { + "check-run-rerequested": { "post": { "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, @@ -91197,21 +93300,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" + "$ref": "#/components/schemas/webhook-check-run-rerequested" }, "examples": { "default": { - "$ref": "#/components/examples/check-run-completed" + "$ref": "#/components/examples/check-run-rerequested" } } }, "application/x-www-form-urlencoded": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" }, "examples": { "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" + "$ref": "#/components/examples/check-run-rerequested-form-encoded" } } } @@ -91235,13 +93338,13 @@ } } }, - "check-run-created": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91306,22 +93409,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -91333,9 +93421,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -91344,13 +93431,13 @@ } } }, - "check-run-requested-action": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91415,22 +93502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -91442,9 +93514,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -91453,13 +93524,13 @@ } } }, - "check-run-rerequested": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91524,22 +93595,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-appeared-in-branch": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -91551,9 +93700,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91562,13 +93710,13 @@ } } }, - "check-suite-completed": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91633,7 +93781,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -91646,7 +93794,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91655,13 +93803,13 @@ } } }, - "check-suite-requested": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91726,7 +93874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -91739,7 +93887,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91748,13 +93896,13 @@ } } }, - "check-suite-rerequested": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91819,7 +93967,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -91832,7 +93980,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91841,11 +93989,11 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -91912,7 +94060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -91934,11 +94082,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -92005,7 +94153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -92027,13 +94175,13 @@ } } }, - "code-scanning-alert-created": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -92098,7 +94246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -92111,7 +94259,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -92120,13 +94268,198 @@ } } }, - "code-scanning-alert-fixed": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-create" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "create", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "custom-property-created": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92191,7 +94524,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } @@ -92204,22 +94537,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "code-scanning-alert-reopened": { + "custom-property-promoted-to-enterprise": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92284,7 +94617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" } } } @@ -92297,22 +94630,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "code-scanning-alert-reopened-by-user": { + "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92377,7 +94710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-custom-property-updated" } } } @@ -92390,22 +94723,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "commit-comment-created": { + "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -92470,7 +94803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } @@ -92483,7 +94816,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "custom-property-values", "supported-webhook-types": [ "repository", "organization", @@ -92492,12 +94825,12 @@ } } }, - "create": { + "delete": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -92562,7 +94895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -92575,7 +94908,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -92584,106 +94917,13 @@ } } }, - "custom-property-created": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A new custom property was created.", - "operationId": "custom-property/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "business", - "organization", - "app" - ] - } - } - }, - "custom-property-deleted": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was deleted.", - "operationId": "custom-property/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92748,7 +94988,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -92761,22 +95001,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-promoted-to-enterprise": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was promoted to an enterprise.", - "operationId": "custom-property/promote-to-enterprise", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92841,7 +95081,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -92854,22 +95094,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-updated": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was updated.", - "operationId": "custom-property/updated", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92934,7 +95174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -92947,22 +95187,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-values-updated": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "The custom property values of a repository were updated.", - "operationId": "custom-property-values/updated", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -93027,7 +95267,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -93040,7 +95280,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom-property-values", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -93049,12 +95289,13 @@ } } }, - "delete": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -93119,7 +95360,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -93132,7 +95373,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -93141,11 +95382,11 @@ } } }, - "dependabot-alert-auto-dismissed": { + "dependabot-alert-reintroduced": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", - "operationId": "dependabot-alert/auto-dismissed", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -93212,7 +95453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -93234,11 +95475,11 @@ } } }, - "dependabot-alert-auto-reopened": { + "dependabot-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", - "operationId": "dependabot-alert/auto-reopened", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -93305,7 +95546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -93327,13 +95568,13 @@ } } }, - "dependabot-alert-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -93398,7 +95639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -93411,7 +95652,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -93420,13 +95661,13 @@ } } }, - "dependabot-alert-dismissed": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -93491,7 +95732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -93504,7 +95745,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -93513,13 +95754,13 @@ } } }, - "dependabot-alert-fixed": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -93584,7 +95825,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -93597,7 +95838,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -93606,13 +95847,13 @@ } } }, - "dependabot-alert-reintroduced": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -93677,7 +95918,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -93690,22 +95931,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dependabot-alert-reopened": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93770,7 +96009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -93783,22 +96022,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deploy-key-created": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93863,7 +96100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -93876,22 +96113,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deploy-key-deleted": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93956,7 +96191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -93969,7 +96204,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -93978,13 +96304,13 @@ } } }, - "deployment-created": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94049,7 +96375,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -94062,7 +96388,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -94071,13 +96397,13 @@ } } }, - "deployment-protection-rule-requested": { + "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94142,7 +96468,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -94155,20 +96481,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-approved": { + "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94190,7 +96518,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -94233,7 +96561,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -94246,20 +96574,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94324,7 +96654,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -94337,20 +96667,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94415,7 +96747,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -94428,20 +96760,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94506,7 +96840,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -94519,7 +96853,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -94528,11 +96862,11 @@ } } }, - "discussion-answered": { + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -94599,7 +96933,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -94621,11 +96955,11 @@ } } }, - "discussion-category-changed": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -94692,7 +97026,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -94714,200 +97048,14 @@ } } }, - "discussion-closed": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "discussions", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-created": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion_comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" - }, "parameters": [ { "name": "User-Agent", @@ -94971,7 +97119,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -94984,7 +97132,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -94993,13 +97141,13 @@ } } }, - "discussion-comment-edited": { + "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -95064,7 +97212,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -95077,7 +97225,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -95086,11 +97234,11 @@ } } }, - "discussion-created": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95157,7 +97305,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -95179,11 +97327,11 @@ } } }, - "discussion-deleted": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95250,7 +97398,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -95272,11 +97420,11 @@ } } }, - "discussion-edited": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95300,7 +97448,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -95343,7 +97491,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -95365,11 +97513,11 @@ } } }, - "discussion-labeled": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95436,7 +97584,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -95458,11 +97606,11 @@ } } }, - "discussion-locked": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95529,7 +97677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -95551,11 +97699,11 @@ } } }, - "discussion-pinned": { + "discussion-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95622,7 +97770,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -95644,11 +97792,11 @@ } } }, - "discussion-reopened": { + "discussion-unlocked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95672,7 +97820,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -95715,7 +97863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -95737,11 +97885,11 @@ } } }, - "discussion-transferred": { + "discussion-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95808,7 +97956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -95830,13 +97978,13 @@ } } }, - "discussion-unanswered": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -95901,7 +98049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -95912,9 +98060,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -95923,13 +98071,13 @@ } } }, - "discussion-unlabeled": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -95994,7 +98142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -96005,9 +98153,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96016,13 +98164,13 @@ } } }, - "discussion-unlocked": { + "dismissal-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was canceled.", + "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96087,7 +98235,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -96098,9 +98246,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96109,13 +98257,13 @@ } } }, - "discussion-unpinned": { + "dismissal-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was completed.", + "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96180,7 +98328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -96191,9 +98339,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96202,13 +98350,13 @@ } } }, - "dismissal-request-code-scanning-created": { + "dismissal-request-secret-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.", - "description": "A code scanning alert dismissal request was created.", - "operationId": "dismissal-request-code-scanning/created", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was created.", + "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96286,7 +98434,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96295,13 +98443,13 @@ } } }, - "dismissal-request-code-scanning-response-submitted": { + "dismissal-request-secret-scanning-response-dismissed": { "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.", - "description": "A code scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-code-scanning/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal response was dismissed.", + "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96366,7 +98514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -96379,7 +98527,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96388,11 +98536,11 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "dismissal-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "description": "A secret scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -96459,7 +98607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -96481,13 +98629,12 @@ } } }, - "dismissal-request-secret-scanning-completed": { + "fork": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was completed.", - "operationId": "dismissal-request-secret-scanning/completed", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -96552,7 +98699,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -96563,10 +98710,11 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "fork", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96574,13 +98722,13 @@ } } }, - "dismissal-request-secret-scanning-created": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was created.", - "operationId": "dismissal-request-secret-scanning/created", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -96645,7 +98793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -96656,24 +98804,21 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "github_app_authorization", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dismissal-request-secret-scanning-response-dismissed": { + "gollum": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was dismissed.", - "operationId": "dismissal-request-secret-scanning/response-dismissed", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -96738,7 +98883,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -96749,9 +98894,9 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "gollum", "supported-webhook-types": [ "repository", "organization", @@ -96760,13 +98905,13 @@ } } }, - "dismissal-request-secret-scanning-response-submitted": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-secret-scanning/response-submitted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -96831,7 +98976,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -96842,23 +98987,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "fork": { + "installation-deleted": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -96923,7 +99067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -96936,23 +99080,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "installation", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "github-app-authorization-revoked": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -97017,7 +99158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -97030,19 +99171,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "gollum": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -97107,7 +99249,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -97120,22 +99262,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "installation-created": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -97200,7 +99340,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -97213,18 +99353,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "installation-deleted": { + "installation-suspend": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -97291,7 +99431,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -97311,13 +99451,13 @@ } } }, - "installation-new-permissions-accepted": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -97382,7 +99522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -97395,20 +99535,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_target", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-added": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -97473,7 +99613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -97486,20 +99626,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-removed": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97564,7 +99704,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -97577,20 +99717,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-suspend": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97655,7 +99797,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -97668,20 +99810,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-target-renamed": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97746,7 +99890,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -97759,20 +99903,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-unsuspend": { + "issue-dependencies-blocked-by-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -97837,7 +99983,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -97850,20 +99996,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue-dependencies", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "issue-dependencies-blocked-by-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocked by relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -97928,7 +100076,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -97941,7 +100089,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -97950,13 +100098,13 @@ } } }, - "issue-comment-deleted": { + "issue-dependencies-blocking-added": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -98021,7 +100169,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -98034,7 +100182,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -98043,13 +100191,13 @@ } } }, - "issue-comment-edited": { + "issue-dependencies-blocking-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -98114,7 +100262,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -98127,7 +100275,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -98136,13 +100284,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98207,7 +100355,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -98220,7 +100368,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98229,13 +100377,13 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocked by relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocked-by-removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98300,7 +100448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -98313,7 +100461,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98322,13 +100470,13 @@ } } }, - "issue-dependencies-blocking-added": { + "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98393,7 +100541,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -98406,7 +100554,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98415,13 +100563,13 @@ } } }, - "issue-dependencies-blocking-removed": { + "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98486,7 +100634,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -98499,7 +100647,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98508,11 +100656,11 @@ } } }, - "issues-assigned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98579,7 +100727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -98601,11 +100749,11 @@ } } }, - "issues-closed": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98672,7 +100820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -98694,11 +100842,11 @@ } } }, - "issues-deleted": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98765,7 +100913,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -98787,11 +100935,11 @@ } } }, - "issues-demilestoned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98858,7 +101006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -98880,11 +101028,11 @@ } } }, - "issues-edited": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98951,7 +101099,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -98973,11 +101121,11 @@ } } }, - "issues-labeled": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99044,7 +101192,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -99066,11 +101214,11 @@ } } }, - "issues-locked": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99137,7 +101285,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -99159,11 +101307,11 @@ } } }, - "issues-milestoned": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99230,7 +101378,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -99252,11 +101400,11 @@ } } }, - "issues-opened": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99323,7 +101471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -99345,11 +101493,11 @@ } } }, - "issues-pinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99416,7 +101564,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -99438,11 +101586,11 @@ } } }, - "issues-reopened": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99509,7 +101657,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -99531,11 +101679,11 @@ } } }, - "issues-transferred": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99602,7 +101750,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -99624,11 +101772,11 @@ } } }, - "issues-typed": { + "issues-unpinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99695,7 +101843,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -99717,11 +101865,11 @@ } } }, - "issues-unassigned": { + "issues-untyped": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99788,7 +101936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-untyped" } } } @@ -99810,13 +101958,13 @@ } } }, - "issues-unlabeled": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -99881,7 +102029,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -99894,7 +102042,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -99903,13 +102051,13 @@ } } }, - "issues-unlocked": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -99974,7 +102122,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -99987,7 +102135,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -99996,13 +102144,13 @@ } } }, - "issues-unpinned": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -100067,7 +102215,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -100080,7 +102228,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -100089,13 +102237,13 @@ } } }, - "issues-untyped": { + "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100160,7 +102308,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -100173,22 +102321,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-created": { + "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100253,7 +102399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -100266,22 +102412,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-deleted": { + "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100346,7 +102490,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -100359,22 +102503,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-edited": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100439,7 +102581,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -100452,20 +102594,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "marketplace-purchase-cancelled": { + "marketplace-purchase-purchased": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -100532,7 +102672,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -100552,13 +102692,13 @@ } } }, - "marketplace-purchase-changed": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100623,7 +102763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -100636,20 +102776,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100714,7 +102857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -100727,20 +102870,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change-cancelled": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100805,7 +102951,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -100818,20 +102964,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-purchased": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -100896,7 +103045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -100909,20 +103058,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "membership", "supported-webhook-types": [ - "marketplace" + "organization", + "business", + "app" ] } } }, - "member-added": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -100987,7 +103138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -101000,23 +103151,25 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "membership", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "member-edited": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -101081,7 +103234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -101094,23 +103247,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "merge_group", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "member-removed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -101175,7 +103328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -101188,23 +103341,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "merge_group", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "membership-added": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -101269,7 +103419,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -101282,22 +103432,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "meta", "supported-webhook-types": [ - "organization", + "marketplace", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101362,7 +103514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -101375,25 +103527,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "merge-group-checks-requested": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101458,7 +103607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -101471,23 +103620,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "merge-group-destroyed": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101552,7 +103700,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -101565,20 +103713,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "meta-deleted": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101643,7 +103793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -101656,10 +103806,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "milestone", "supported-webhook-types": [ - "marketplace", - "business", "repository", "organization", "app" @@ -101667,11 +103815,11 @@ } } }, - "milestone-closed": { + "milestone-opened": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -101738,7 +103886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -101760,13 +103908,106 @@ } } }, - "milestone-created": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-blocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "org-block-unblocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -101831,7 +104072,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -101844,22 +104085,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-deleted": { + "organization-custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "A new organization custom property was created.", + "operationId": "organization-custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -101924,7 +104165,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } @@ -101935,24 +104176,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "milestone-edited": { + "organization-custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was deleted.", + "operationId": "organization-custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102017,7 +104256,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } @@ -102028,24 +104267,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "milestone-opened": { + "organization-custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was updated.", + "operationId": "organization-custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102110,7 +104347,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } @@ -102121,24 +104358,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "org-block-blocked": { + "organization-custom-property-values-updated": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to custom property values for an organization.", + "description": "The custom property values of an organization were updated.", + "operationId": "organization-custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -102203,7 +104438,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } @@ -102214,105 +104449,12 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization-custom-property-values", "supported-webhook-types": [ - "organization", "business", - "app" - ] - } - } - }, - "org-block-unblocked": { - "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "org_block", - "supported-webhook-types": [ "organization", - "business", "app" ] } @@ -116949,6 +119091,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -117147,6 +119297,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -119210,6 +121369,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -119342,6 +121506,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -119354,6 +121522,102 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -122834,6 +125098,60 @@ ], "additionalProperties": true }, + "copilot-usage-metrics-1-day-report": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "copilot-usage-metrics-28-day-report": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, "dependabot-alert-package": { "type": "object", "description": "Details for the vulnerable package.", @@ -123350,6 +125668,224 @@ "region" ] }, + "custom-property-base": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + "organization-custom-property": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "$ref": "#/components/schemas/custom-property-base" + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "organization-custom-property-payload": { + "title": "Organization Custom Property Payload", + "description": "Payload for creating or updating an organization custom property definition on an enterprise.", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property." + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property." + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property." + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property." + } + }, + "required": [ + "value_type" + ] + }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "custom-properties-for-orgs-get-enterprise-property-values": { + "title": "Enterprise Organization Custom Property Values", + "description": "List of custom property values for an organization", + "type": "object", + "properties": { + "organization_id": { + "type": "integer", + "example": 1296269 + }, + "organization_login": { + "type": "string", + "example": "Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "organization_id", + "organization_login", + "properties" + ] + }, "custom-property": { "title": "Organization Custom Property", "description": "Custom property defined on an organization", @@ -123833,6 +126369,38 @@ "$ref": "#/components/schemas/repository-ruleset-conditions" } ] + }, + { + "type": "object", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] + }, + { + "type": "object", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] } ] }, @@ -126121,7 +128689,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -126129,7 +128697,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -126137,7 +128705,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -130503,7 +133071,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -130511,7 +133079,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -130519,7 +133087,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -131222,6 +133790,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "campaign-summary": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", @@ -135656,36 +138233,6 @@ "archived_at" ] }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "nullable": true - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -155368,7 +157915,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -155376,7 +157923,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -155384,7 +157931,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -207464,6 +210011,144 @@ "sender" ] }, + "webhook-organization-custom-property-created": { + "title": "organization custom property created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "definition": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-deleted": { + "title": "organization custom property deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "definition": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property that was deleted." + } + }, + "required": [ + "property_name" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-updated": { + "title": "organization custom property updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "definition": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-values-updated": { + "title": "Custom property values updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "new_property_values": { + "type": "array", + "description": "The new custom property values.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "old_property_values": { + "type": "array", + "description": "The old custom property values.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "action", + "organization", + "enterprise", + "new_property_values", + "old_property_values" + ] + }, "webhook-organization-deleted": { "title": "organization deleted event", "type": "object", @@ -299242,6 +301927,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -300770,6 +303494,25 @@ } ] }, + "copilot-usage-metrics-1-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + }, + "copilot-usage-metrics-28-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + }, "dependabot-alerts-for-organization": { "value": [ { @@ -301236,6 +303979,99 @@ "region": "eastus" } }, + "organization-custom-properties": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + }, + "organization-custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + }, + "custom-properties-for-orgs-get-enterprise-property-values": { + "value": [ + { + "organization_id": 1296269, + "organization_login": "Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + }, + "custom-properties-for-orgs-patch-enterprise-property-values": { + "value": { + "organization_logins": [ + "acme", + "github" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "custom-properties": { "value": [ { @@ -301832,6 +304668,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -303352,24 +306222,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "organization-custom-repository-role-example": { "value": { "id": 8030, @@ -303475,6 +306327,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -304378,6 +307264,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -320687,40 +323585,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -330670,6 +333534,25 @@ "type": "string" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -330885,6 +333768,17 @@ "type": "integer" } }, + "day": { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -330972,29 +333866,6 @@ "default": "created" } }, - "pagination-first": { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - "pagination-last": { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, "username": { "name": "username", "description": "The handle for the GitHub user account.", @@ -331128,6 +333999,19 @@ ] } }, + "cost-center-state": { + "name": "state", + "in": "query", + "description": "Set to `active` or `deleted` to only list cost centers in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ] + } + }, "cost-center": { "name": "cost_center_id", "description": "The ID corresponding to the cost center.", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 42a740559..8191f02ba 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -99,6 +99,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -1748,6 +1750,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -1767,6 +1774,11 @@ paths: `GET actions/hosted-runners/limits` type: boolean default: false + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -1797,6 +1809,199 @@ paths: githubCloudOnly: true category: actions subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an enterprise + description: |- + List custom images for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get an enterprise custom image definition for GitHub Actions Hosted + Runners + description: |- + Get an enterprise custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the enterprise + description: |- + Delete a custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an enterprise + description: |- + List image versions of a custom image for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of an enterprise custom image for GitHub Actions + Hosted Runners + description: |- + Get an image version of an enterprise custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the enterprise + description: |- + Delete an image version of custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an enterprise @@ -2053,6 +2258,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -6187,6 +6397,168 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": + get: + summary: Get Copilot enterprise usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -6217,8 +6589,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -6591,6 +6961,338 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations + "/enterprises/{enterprise}/org-properties/schema": + get: + summary: Get organization custom properties schema for an enterprise + description: |- + Gets all organization custom property definitions that are defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update organization custom property definitions on an enterprise + description: |- + Creates new or updates existing organization custom properties defined on an enterprise in a batch. + + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of organization custom properties to create + or update. + items: + "$ref": "#/components/schemas/organization-custom-property" + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": + get: + summary: Get an organization custom property definition from an enterprise + description: |- + Gets an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + put: + summary: Create or update an organization custom property definition on an enterprise + description: |- + Creates a new or updates an existing organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property-payload" + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + delete: + summary: Remove an organization custom property definition from an enterprise + description: |- + Removes an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '204': + "$ref": "#/components/responses/no_content" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/values": + get: + summary: List custom property values for organizations in an enterprise + description: |- + Lists enterprise organizations with all of their custom property values. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-properties-for-orgs-get-enterprise-property-values" + examples: + default: + "$ref": "#/components/examples/custom-properties-for-orgs-get-enterprise-property-values" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for organizations in an enterprise + description: |- + Create or update custom property values for organizations in an enterprise. + + To remove a custom property value from an organization, set the property value to `null`. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "edit enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + organization_logins: + type: array + description: The names of organizations that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the organizations. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - organization_logins + - properties + examples: + default: + "$ref": "#/components/examples/custom-properties-for-orgs-patch-enterprise-property-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/properties/schema": get: summary: Get custom properties for an enterprise @@ -7219,7 +7921,7 @@ paths: '503': "$ref": "#/components/responses/service_unavailable" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -7436,6 +8138,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/cost-center-state" responses: '200': "$ref": "#/components/responses/get_all_cost_centers" @@ -7842,8 +8545,10 @@ paths: "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise - description: Gets a report of premium request usage for an enterprise. To use - this endpoint, you must be an administrator or billing manager of the enterprise. + description: |- + Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe @@ -8111,6 +8816,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -8357,6 +9074,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -8430,6 +9350,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10864,12 +11796,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -11435,6 +12462,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -11452,6 +12484,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -11483,6 +12520,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -11739,6 +12967,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -15033,6 +16266,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -15523,6 +16803,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -15532,7 +16813,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -18381,8 +19666,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -23518,16 +24801,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -23639,16 +24925,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -40171,14 +41460,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -40189,8 +41470,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -52803,6 +54082,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -63913,16 +65195,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64030,16 +65315,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64400,7 +65688,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -65844,16 +67135,182 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-created" + "$ref": "#/components/schemas/webhook-check-run-created" + examples: + default: + "$ref": "#/components/examples/check-run-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/check-run-created-form-encoded" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: check_run + supported-webhook-types: + - repository + - organization + - app + check-run-requested-action: + post: + summary: |- + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + + For activity relating to check suites, use the `check-suite` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + + Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: A check run completed, and someone requested a followup action + that your app provides. Only the GitHub App someone requests to perform an + action will receive the `requested_action` payload. For more information, + see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." + operationId: check-run/requested-action + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-check-run-requested-action" + examples: + default: + "$ref": "#/components/examples/check-run-requested-action" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + examples: + default: + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: check_run + supported-webhook-types: + - repository + - organization + - app + check-run-rerequested: + post: + summary: |- + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + + For activity relating to check suites, use the `check-suite` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + + Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: Someone requested to re-run a check run. Only the GitHub App that + someone requests to re-run the check will receive the `rerequested` payload. + operationId: check-run/rerequested + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-check-run-rerequested" examples: default: - "$ref": "#/components/examples/check-run-created" + "$ref": "#/components/examples/check-run-rerequested" application/x-www-form-urlencoded: schema: - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" examples: default: - "$ref": "#/components/examples/check-run-created-form-encoded" + "$ref": "#/components/examples/check-run-rerequested-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65867,26 +67324,24 @@ x-webhooks: - repository - organization - app - check-run-requested-action: + check-suite-completed: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - For activity relating to check suites, use the `check-suite` event. + For activity relating to check runs, use the `check_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: A check run completed, and someone requested a followup action - that your app provides. Only the GitHub App someone requests to perform an - action will receive the `requested_action` payload. For more information, - see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." - operationId: check-run/requested-action + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: All check runs in a check suite have completed, and a conclusion + is available. + operationId: check-suite/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -65928,47 +67383,40 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-requested-action" - examples: - default: - "$ref": "#/components/examples/check-run-requested-action" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - examples: - default: - "$ref": "#/components/examples/check-run-requested-action-form-encoded" + "$ref": "#/components/schemas/webhook-check-suite-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: check_run + subcategory: check_suite supported-webhook-types: - repository - organization - app - check-run-rerequested: + check-suite-requested: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - For activity relating to check suites, use the `check-suite` event. + For activity relating to check runs, use the `check_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run a check run. Only the GitHub App that - someone requests to re-run the check will receive the `rerequested` payload. - operationId: check-run/rerequested + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: Someone requested to run a check suite. By default, check suites + are automatically created when you create a check run. For more information, + see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" + in the REST API documentation. + operationId: check-suite/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -66010,30 +67458,20 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-rerequested" - examples: - default: - "$ref": "#/components/examples/check-run-rerequested" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - examples: - default: - "$ref": "#/components/examples/check-run-rerequested-form-encoded" + "$ref": "#/components/schemas/webhook-check-suite-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: check_run + subcategory: check_suite supported-webhook-types: - repository - organization - app - check-suite-completed: + check-suite-rerequested: post: summary: |- This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. @@ -66046,9 +67484,12 @@ x-webhooks: > [!NOTE] > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: All check runs in a check suite have completed, and a conclusion - is available. - operationId: check-suite/completed + description: Someone requested to re-run the check runs in a check suite. For + more information, see [the GraphQL API documentation for creating a check + suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: @@ -66092,7 +67533,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66105,27 +67546,18 @@ x-webhooks: - repository - organization - app - check-suite-requested: + code-scanning-alert-appeared-in-branch: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to run a check suite. By default, check suites - are automatically created when you create a check run. For more information, - see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) - or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" - in the REST API documentation. - operationId: check-suite/requested + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: A previously created code scanning alert appeared in another branch. + This can happen when a branch is merged into or created from a branch with + a pre-existing code scanning alert. + operationId: code-scanning-alert/appeared-in-branch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -66167,7 +67599,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66175,32 +67607,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - check-suite-rerequested: + code-scanning-alert-closed-by-user: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run the check runs in a check suite. For - more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" - in the REST API documentation. - operationId: check-suite/rerequested + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: Someone closed a code scanning alert. + operationId: code-scanning-alert/closed-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -66242,7 +67663,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66250,21 +67671,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - code-scanning-alert-appeared-in-branch: + code-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously created code scanning alert appeared in another branch. - This can happen when a branch is merged into or created from a branch with - a pre-existing code scanning alert. - operationId: code-scanning-alert/appeared-in-branch + description: A code scanning alert was created in a repository. + operationId: code-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66308,7 +67727,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66321,14 +67740,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-closed-by-user: + code-scanning-alert-fixed: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone closed a code scanning alert. - operationId: code-scanning-alert/closed-by-user + description: A code scanning alert was fixed in a branch by a commit. + operationId: code-scanning-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66372,7 +67791,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66385,14 +67804,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-created: + code-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To 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 was created in a repository. - operationId: code-scanning-alert/created + description: A previously fixed code scanning alert reappeared in a branch. + operationId: code-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66436,7 +67855,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66449,14 +67868,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-fixed: + code-scanning-alert-reopened-by-user: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To 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 was fixed in a branch by a commit. - operationId: code-scanning-alert/fixed + description: Someone reopened a code scanning alert. + operationId: code-scanning-alert/reopened-by-user externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66500,7 +67919,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66513,16 +67932,85 @@ x-webhooks: - repository - organization - app - code-scanning-alert-reopened: + commit-comment-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously fixed code scanning alert reappeared in a branch. - operationId: code-scanning-alert/reopened + For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: Someone commented on a commit. + operationId: commit-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-commit-comment-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: commit_comment + supported-webhook-types: + - repository + - organization + - app + create: + post: + summary: |- + This event occurs when a Git branch or tag is created. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + **Notes**: + - This event will not occur when more than three tags are created at once. + - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. + operationId: create + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header @@ -66564,7 +68052,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66572,21 +68060,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: create supported-webhook-types: - repository - organization - app - code-scanning-alert-reopened-by-user: + custom-property-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone reopened a code scanning alert. - operationId: code-scanning-alert/reopened-by-user + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A new custom property was created. + operationId: custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66628,7 +68118,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66636,23 +68126,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - commit-comment-created: + custom-property-deleted: post: summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. + This event occurs when there is activity relating to a custom property. - For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: Someone commented on a commit. - operationId: commit-comment/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was deleted. + operationId: custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66694,7 +68184,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66702,24 +68192,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: commit_comment + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - create: + custom-property-promoted-to-enterprise: post: summary: |- - This event occurs when a Git branch or tag is created. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. - **Notes**: - - This event will not occur when more than three tags are created at once. - - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. - operationId: create + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66761,7 +68250,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66769,12 +68258,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: create + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - custom-property-created: + custom-property-updated: post: summary: |- This event occurs when there is activity relating to a custom property. @@ -66782,8 +68271,8 @@ x-webhooks: For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A new custom property was created. - operationId: custom-property/created + description: A custom property was updated. + operationId: custom-property/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: @@ -66827,7 +68316,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-created" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66840,18 +68329,18 @@ x-webhooks: - business - organization - app - custom-property-deleted: + custom-property-values-updated: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when there is activity relating to custom property values for a repository. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was deleted. - operationId: custom-property/deleted + description: The custom property values of a repository were updated. + operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -66893,7 +68382,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-deleted" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66901,23 +68390,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: custom-property-values supported-webhook-types: - - business + - repository - organization - app - custom-property-promoted-to-enterprise: + delete: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including + branch and tag deletions, use the [`push`](#push) webhook event. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was promoted to an enterprise. - operationId: custom-property/promote-to-enterprise + > [!NOTE] + > This event will not occur when more than three tags are deleted at once. + operationId: delete externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -66959,7 +68449,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66967,23 +68457,27 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: delete supported-webhook-types: - - business + - repository - organization - app - custom-property-updated: + dependabot-alert-auto-dismissed: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when there is activity relating to Dependabot alerts. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was updated. - operationId: custom-property/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67025,7 +68519,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67033,23 +68527,28 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: dependabot_alert supported-webhook-types: - - business + - repository - organization - app - custom-property-values-updated: + dependabot-alert-auto-reopened: post: summary: |- - This event occurs when there is activity relating to custom property values for a repository. + This event occurs when there is activity relating to Dependabot alerts. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: The custom property values of a repository were updated. - operationId: custom-property-values/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert, that had been automatically closed by a Dependabot + auto-triage rule, was automatically reopened because the alert metadata or + rule changed. + operationId: dependabot-alert/auto-reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67091,7 +68590,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67099,24 +68598,28 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom-property-values + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - delete: + dependabot-alert-created: post: summary: |- - This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including - branch and tag deletions, use the [`push`](#push) webhook event. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > This event will not occur when more than three tags are deleted at once. - operationId: delete + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change introduced a vulnerable dependency, or a + GitHub Security Advisory was published and an existing dependency was found + to be vulnerable. + operationId: dependabot-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67158,7 +68661,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67166,12 +68669,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: delete + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - dependabot-alert-auto-dismissed: + dependabot-alert-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67182,9 +68685,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was automatically closed by a Dependabot auto-triage - rule. - operationId: dependabot-alert/auto-dismissed + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67228,7 +68730,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67241,7 +68743,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-auto-reopened: + dependabot-alert-fixed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67252,10 +68754,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert, that had been automatically closed by a Dependabot - auto-triage rule, was automatically reopened because the alert metadata or - rule changed. - operationId: dependabot-alert/auto-reopened + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67299,7 +68799,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67312,7 +68812,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-created: + dependabot-alert-reintroduced: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67323,10 +68823,9 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency, or a - GitHub Security Advisory was published and an existing dependency was found - to be vulnerable. - operationId: dependabot-alert/created + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67370,7 +68869,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67383,7 +68882,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-dismissed: + dependabot-alert-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67394,8 +68893,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67439,7 +68938,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67452,21 +68951,16 @@ x-webhooks: - repository - organization - app - dependabot-alert-fixed: + deploy-key-created: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change removed a vulnerability. - operationId: dependabot-alert/fixed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deploy key was created. + operationId: deploy-key/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -67508,7 +69002,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-deploy-key-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67516,27 +69010,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deploy_key supported-webhook-types: - repository - organization - app - dependabot-alert-reintroduced: + deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency that - had previously been fixed. - operationId: dependabot-alert/reintroduced + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deploy key was deleted. + operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -67578,7 +69066,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67586,26 +69074,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deploy_key supported-webhook-types: - repository - organization - app - dependabot-alert-reopened: + deployment-created: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + For activity relating to deployment status, use the `deployment_status` event. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was manually reopened. - operationId: dependabot-alert/reopened + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment was created. + operationId: deployment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header @@ -67647,7 +69132,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deployment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67655,21 +69140,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deployment supported-webhook-types: - repository - organization - app - deploy-key-created: + deployment-protection-rule-requested: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was created. - operationId: deploy-key/created + description: A deployment protection rule was requested for an environment. + operationId: deployment-protection-rule/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -67711,7 +69196,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67719,21 +69204,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: deployment_protection_rule supported-webhook-types: - - repository - - organization - app - deploy-key-deleted: + deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was deleted. - operationId: deploy-key/deleted + description: A deployment review was approved. + operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67775,7 +69260,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67783,23 +69268,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: deployment_review supported-webhook-types: - - repository - - organization - app - deployment-created: + deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment status, use the `deployment_status` event. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment was created. - operationId: deployment/created + description: A deployment review was rejected. + operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67841,7 +69324,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67849,21 +69332,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment + subcategory: deployment_review supported-webhook-types: - - repository - - organization - app - deployment-protection-rule-requested: + deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment protection rule was requested for an environment. - operationId: deployment-protection-rule/requested + description: A deployment review was requested. + operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67905,7 +69388,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-deployment-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67913,21 +69396,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_protection_rule + subcategory: deployment_review supported-webhook-types: - app - deployment-review-approved: + deployment-status-created: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was approved. - operationId: deployment-review/approved + + > [!NOTE] + > A webhook event is not fired for deployment statuses with an `inactive` state. + description: A new deployment status was created. + operationId: deployment-status/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header @@ -67969,7 +69455,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-deployment-status-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67977,21 +69463,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: deployment_status supported-webhook-types: + - repository + - organization - app - deployment-review-rejected: + discussion-answered: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was rejected. - operationId: deployment-review/rejected + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A comment on the discussion was marked as the answer. + operationId: discussion/answered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68033,7 +69524,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-discussion-answered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68041,21 +69532,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: discussion supported-webhook-types: + - repository + - organization - app - deployment-review-requested: + discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was requested. - operationId: deployment-review/requested + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: The category of a discussion was changed. + operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68097,7 +69593,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-discussion-category-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68105,24 +69601,95 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: discussion supported-webhook-types: + - repository + - organization - app - deployment-status-created: + discussion-closed: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation, use the `deployment` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > A webhook event is not fired for deployment statuses with an `inactive` state. - description: A new deployment status was created. - operationId: deployment-status/created + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A discussion was closed. + operationId: discussion/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: discussions + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-closed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + discussion-comment-created: + post: + summary: |- + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A comment on a discussion was created. + operationId: discussion-comment/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68164,7 +69731,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68172,26 +69739,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_status + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-answered: + discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was marked as the answer. - operationId: discussion/answered + description: A comment on a discussion was deleted. + operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68233,7 +69800,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68241,26 +69808,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-category-changed: + discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The category of a discussion was changed. - operationId: discussion/category-changed + description: A comment on a discussion was edited. + operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68302,7 +69869,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68310,12 +69877,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-closed: + discussion-created: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68326,8 +69893,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was closed. - operationId: discussion/closed + description: A discussion was created. + operationId: discussion/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68343,7 +69910,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -68371,7 +69938,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-discussion-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68384,21 +69951,21 @@ x-webhooks: - repository - organization - app - discussion-comment-created: + discussion-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was created. - operationId: discussion-comment/created + description: A discussion was deleted. + operationId: discussion/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68440,7 +70007,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68448,26 +70015,27 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-deleted: + discussion-edited: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was deleted. - operationId: discussion-comment/deleted + description: The title or body on a discussion was edited, or the category of + the discussion was changed. + operationId: discussion/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68509,7 +70077,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68517,26 +70085,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-edited: + discussion-labeled: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was edited. - operationId: discussion-comment/edited + description: A label was added to a discussion. + operationId: discussion/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68578,7 +70146,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68586,12 +70154,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-created: + discussion-locked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68602,8 +70170,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was created. - operationId: discussion/created + description: A discussion was locked. + operationId: discussion/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68647,7 +70215,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68660,7 +70228,7 @@ x-webhooks: - repository - organization - app - discussion-deleted: + discussion-pinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68671,8 +70239,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was deleted. - operationId: discussion/deleted + description: A discussion was pinned. + operationId: discussion/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68716,7 +70284,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68729,7 +70297,7 @@ x-webhooks: - repository - organization - app - discussion-edited: + discussion-reopened: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68740,9 +70308,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The title or body on a discussion was edited, or the category of - the discussion was changed. - operationId: discussion/edited + description: A discussion was reopened. + operationId: discussion/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68758,7 +70325,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -68786,7 +70353,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68799,7 +70366,7 @@ x-webhooks: - repository - organization - app - discussion-labeled: + discussion-transferred: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68810,8 +70377,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was added to a discussion. - operationId: discussion/labeled + description: A discussion was transferred to another repository. + operationId: discussion/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68855,7 +70422,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68868,7 +70435,7 @@ x-webhooks: - repository - organization - app - discussion-locked: + discussion-unanswered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68879,8 +70446,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was locked. - operationId: discussion/locked + description: A comment on the discussion was unmarked as the answer. + operationId: discussion/unanswered externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68924,7 +70491,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-unanswered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68937,7 +70504,7 @@ x-webhooks: - repository - organization - app - discussion-pinned: + discussion-unlabeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68948,8 +70515,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was pinned. - operationId: discussion/pinned + description: A label was removed from a discussion. + operationId: discussion/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68993,7 +70560,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69006,7 +70573,7 @@ x-webhooks: - repository - organization - app - discussion-reopened: + discussion-unlocked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -69017,8 +70584,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was reopened. - operationId: discussion/reopened + description: A discussion was unlocked. + operationId: discussion/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -69034,7 +70601,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -69062,7 +70629,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69075,7 +70642,7 @@ x-webhooks: - repository - organization - app - discussion-transferred: + discussion-unpinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -69086,8 +70653,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was transferred to another repository. - operationId: discussion/transferred + description: A discussion was unpinned. + operationId: discussion/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -69131,7 +70698,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69144,21 +70711,16 @@ x-webhooks: - repository - organization - app - discussion-unanswered: + dismissal-request-code-scanning-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was unmarked as the answer. - operationId: discussion/unanswered + To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -69200,34 +70762,29 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app - discussion-unlabeled: + dismissal-request-code-scanning-response-submitted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was removed from a discussion. - operationId: discussion/unlabeled + To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -69269,34 +70826,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app - discussion-unlocked: + dismissal-request-secret-scanning-cancelled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unlocked. - operationId: discussion/unlocked + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was canceled. + operationId: dismissal-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69338,34 +70893,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app - discussion-unpinned: + dismissal-request-secret-scanning-completed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unpinned. - operationId: discussion/unpinned + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was completed. + operationId: dismissal-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69407,29 +70960,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app - dismissal-request-code-scanning-created: + dismissal-request-secret-scanning-created: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was created. + operationId: dismissal-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69476,137 +71032,6 @@ x-webhooks: '200': description: Return a 200 status to indicate that the data was received successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: dismissal_request_code_scanning - supported-webhook-types: - - repository - - organization - - app - 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. - - To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: dismissal_request_code_scanning - supported-webhook-types: - - repository - - organization - - app - dismissal-request-secret-scanning-cancelled: - post: - summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was canceled. - operationId: dismissal-request-secret-scanning/cancelled - externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully x-github: githubCloudOnly: true category: webhooks @@ -69615,7 +71040,7 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-completed: + dismissal-request-secret-scanning-response-dismissed: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. @@ -69624,8 +71049,8 @@ x-webhooks: [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was completed. - operationId: dismissal-request-secret-scanning/completed + description: A secret scanning alert dismissal response was dismissed. + operationId: dismissal-request-secret-scanning/response-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: @@ -69669,7 +71094,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69682,7 +71107,7 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-created: + dismissal-request-secret-scanning-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. @@ -69691,8 +71116,8 @@ x-webhooks: [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was created. - operationId: dismissal-request-secret-scanning/created + description: A secret scanning alert dismissal response was submitted. + operationId: dismissal-request-secret-scanning/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: @@ -69736,7 +71161,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69749,19 +71174,15 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-response-dismissed: + fork: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal response was dismissed. - operationId: dismissal-request-secret-scanning/response-dismissed + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: fork externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header @@ -69803,32 +71224,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-fork" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: true + githubCloudOnly: false category: webhooks - subcategory: dismissal_request_secret_scanning + subcategory: fork supported-webhook-types: + - business - repository - organization - app - dismissal-request-secret-scanning-response-submitted: + github-app-authorization-revoked: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + A GitHub App receives this webhook by default and cannot unsubscribe from this event. - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal response was submitted. - operationId: dismissal-request-secret-scanning/response-submitted + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + description: Someone revoked their authorization of a GitHub App. + operationId: github-app-authorization/revoked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header @@ -69870,28 +71291,26 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: true + githubCloudOnly: false category: webhooks - subcategory: dismissal_request_secret_scanning + subcategory: github_app_authorization supported-webhook-types: - - repository - - organization - app - fork: + gollum: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: fork + operationId: gollum externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -69933,7 +71352,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-gollum" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69941,24 +71360,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: fork + subcategory: gollum supported-webhook-types: - - business - repository - organization - app - github-app-authorization-revoked: + installation-created: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - - A GitHub App receives this webhook by default and cannot unsubscribe from this event. + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - description: Someone revoked their authorization of a GitHub App. - operationId: github-app-authorization/revoked + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + description: Someone installed a GitHub App on a user or organization account. + operationId: installation/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70000,7 +71416,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-installation-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70008,18 +71424,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: github_app_authorization + subcategory: installation supported-webhook-types: - app - gollum: + installation-deleted: post: summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: gollum + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + description: Someone uninstalled a GitHub App from their user or organization + account. + operationId: installation/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70061,7 +71479,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70069,19 +71487,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: gollum + subcategory: installation supported-webhook-types: - - repository - - organization - app - installation-created: + installation-new-permissions-accepted: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone installed a GitHub App on a user or organization account. - operationId: installation/created + description: Someone granted new permissions to a GitHub App. + operationId: installation/new-permissions-accepted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: @@ -70125,7 +71541,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70136,17 +71552,16 @@ x-webhooks: subcategory: installation supported-webhook-types: - app - installation-deleted: + installation-repositories-added: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone uninstalled a GitHub App from their user or organization - account. - operationId: installation/deleted + description: A GitHub App installation was granted access to one or more repositories. + operationId: installation-repositories/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -70188,7 +71603,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-repositories-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70196,19 +71611,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: installation_repositories supported-webhook-types: - app - installation-new-permissions-accepted: + installation-repositories-removed: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone granted new permissions to a GitHub App. - operationId: installation/new-permissions-accepted + description: Access to one or more repositories was revoked for a GitHub App + installation. + operationId: installation-repositories/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -70250,7 +71666,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70258,19 +71674,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: installation_repositories supported-webhook-types: - app - installation-repositories-added: + installation-suspend: post: summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: A GitHub App installation was granted access to one or more repositories. - operationId: installation-repositories/added + description: Someone blocked access by a GitHub App to their user or organization + account. + operationId: installation/suspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70312,7 +71729,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-suspend" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70320,20 +71737,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_repositories + subcategory: installation supported-webhook-types: - app - installation-repositories-removed: + installation-target-renamed: post: - summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Access to one or more repositories was revoked for a GitHub App - installation. - operationId: installation-repositories/removed + summary: This event occurs when there is activity relating to the user or organization + account that a GitHub App is installed on. For more information, see "[About + apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." + For information about the APIs to manage GitHub Apps, see [the GraphQL API + documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in + the REST API documentation. + description: Somebody renamed the user or organization account that a GitHub + App is installed on. + operationId: installation-target/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header @@ -70375,7 +71795,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-installation-target-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70383,18 +71803,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_repositories + subcategory: installation_target supported-webhook-types: - app - installation-suspend: + installation-unsuspend: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone blocked access by a GitHub App to their user or organization - account. - operationId: installation/suspend + description: A GitHub App that was blocked from accessing a user or organization + account was given access the account again. + operationId: installation/unsuspend externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: @@ -70438,7 +71858,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-installation-unsuspend" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70449,20 +71869,18 @@ x-webhooks: subcategory: installation supported-webhook-types: - app - installation-target-renamed: + issue-comment-created: post: - summary: This event occurs when there is activity relating to the user or organization - account that a GitHub App is installed on. For more information, see "[About - apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." - For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) - or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in - the REST API documentation. - description: Somebody renamed the user or organization account that a GitHub - App is installed on. - operationId: installation-target/renamed + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was created. + operationId: issue-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -70504,7 +71922,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-issue-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70512,20 +71930,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_target + subcategory: issue_comment supported-webhook-types: + - repository + - organization - app - installation-unsuspend: + issue-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: A GitHub App that was blocked from accessing a user or organization - account was given access the account again. - operationId: installation/unsuspend + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -70567,7 +71988,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70575,10 +71996,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: issue_comment supported-webhook-types: + - repository + - organization - app - issue-comment-created: + issue-comment-edited: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. @@ -70586,8 +72009,8 @@ x-webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was created. - operationId: issue-comment/created + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -70631,7 +72054,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issue-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70644,18 +72067,18 @@ x-webhooks: - repository - organization - app - issue-comment-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -70697,7 +72120,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70705,23 +72128,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue_comment + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issue-comment-edited: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -70763,7 +72187,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70771,12 +72195,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue_comment + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issue-dependencies-blocked-by-added: + issue-dependencies-blocking-added: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. @@ -70784,8 +72208,8 @@ x-webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: @@ -70829,7 +72253,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70842,7 +72266,7 @@ x-webhooks: - repository - organization - app - issue-dependencies-blocked-by-removed: + issue-dependencies-blocking-removed: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. @@ -70850,9 +72274,9 @@ x-webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: @@ -70896,7 +72320,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70909,18 +72333,18 @@ x-webhooks: - repository - organization - app - issue-dependencies-blocking-added: + issues-assigned: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. - For activity relating to issues more generally, use the `issues` event instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocking another issue. - operationId: issue-dependencies/blocking-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -70962,7 +72386,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70970,24 +72394,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issues supported-webhook-types: - repository - organization - app - issue-dependencies-blocking-removed: + issues-closed: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. - For activity relating to issues more generally, use the `issues` event instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was closed. + operationId: issues/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -71029,7 +72452,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71037,12 +72460,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issues supported-webhook-types: - repository - organization - app - issues-assigned: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71050,8 +72473,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71095,7 +72518,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71108,7 +72531,7 @@ x-webhooks: - repository - organization - app - issues-closed: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71116,8 +72539,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71161,7 +72584,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71174,7 +72597,7 @@ x-webhooks: - repository - organization - app - issues-deleted: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71182,8 +72605,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71227,7 +72650,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71240,7 +72663,7 @@ x-webhooks: - repository - organization - app - issues-demilestoned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71248,8 +72671,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71293,7 +72716,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71306,7 +72729,7 @@ x-webhooks: - repository - organization - app - issues-edited: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71314,8 +72737,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71359,7 +72783,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71372,7 +72796,7 @@ x-webhooks: - repository - organization - app - issues-labeled: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71380,8 +72804,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71425,7 +72849,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71438,7 +72862,7 @@ x-webhooks: - repository - organization - app - issues-locked: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71446,9 +72870,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71492,7 +72916,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71505,7 +72929,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71513,8 +72937,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71558,7 +72983,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71571,7 +72996,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71579,9 +73004,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71625,7 +73049,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71638,7 +73062,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71646,9 +73070,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71692,7 +73116,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71705,7 +73129,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71713,8 +73137,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71758,7 +73182,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71771,7 +73195,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71779,9 +73203,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71825,7 +73248,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71838,7 +73261,7 @@ x-webhooks: - repository - organization - app - issues-typed: + issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71846,8 +73269,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71891,7 +73314,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71904,7 +73327,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71912,8 +73335,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71957,7 +73381,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71970,7 +73394,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-unpinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71978,8 +73402,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72023,7 +73448,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72036,7 +73461,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-untyped: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72044,9 +73469,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72090,7 +73514,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72103,19 +73527,18 @@ x-webhooks: - repository - organization - app - issues-unpinned: + label-created: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was created. + operationId: label/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -72157,7 +73580,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72165,23 +73588,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: label supported-webhook-types: - repository - organization - app - issues-untyped: + label-deleted: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -72223,7 +73646,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72231,12 +73654,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: label supported-webhook-types: - repository - organization - app - label-created: + label-edited: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. @@ -72244,8 +73667,8 @@ x-webhooks: If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: @@ -72289,7 +73712,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72302,18 +73725,19 @@ x-webhooks: - repository - organization - app - label-deleted: + marketplace-purchase-cancelled: post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + in the REST API documentation. + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -72355,7 +73779,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72363,23 +73787,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: marketplace_purchase supported-webhook-types: - - repository - - organization - - app - label-edited: + - marketplace + marketplace-purchase-changed: post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + in the REST API documentation. + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -72421,7 +73844,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72429,12 +73852,10 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: marketplace_purchase supported-webhook-types: - - repository - - organization - - app - marketplace-purchase-cancelled: + - marketplace + marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72442,9 +73863,11 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72488,7 +73911,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72499,7 +73922,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-changed: + marketplace-purchase-pending-change-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72507,9 +73930,10 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72553,7 +73977,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72564,7 +73988,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change: + marketplace-purchase-purchased: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72572,11 +73996,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72620,7 +74042,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72631,20 +74053,16 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change-cancelled: + member-added: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" - in the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + summary: |- + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -72686,7 +74104,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72694,22 +74112,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: member supported-webhook-types: - - marketplace - marketplace-purchase-purchased: + - business + - repository + - organization + - app + member-edited: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" - in the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + summary: |- + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -72751,7 +74169,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72759,17 +74177,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: member supported-webhook-types: - - marketplace - member-added: + - business + - repository + - organization + - app + member-removed: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: @@ -72813,7 +74234,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72827,16 +74248,80 @@ x-webhooks: - repository - organization - app - member-edited: + membership-added: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + description: An organization member was added to a team. + operationId: membership/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-membership-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: membership + supported-webhook-types: + - organization + - business + - app + membership-removed: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -72878,7 +74363,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-membership-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72886,22 +74371,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: membership supported-webhook-types: - - business - - repository - organization + - business - app - member-removed: + merge-group-checks-requested: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. + + When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. + operationId: merge-group/checks-requested + tags: + - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -72943,7 +74432,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72951,22 +74440,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: merge_group supported-webhook-types: - - business - - repository - - organization - app - membership-added: + merge-group-destroyed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. + + When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. + operationId: merge-group/destroyed + tags: + - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -73008,7 +74499,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73016,21 +74507,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: merge_group supported-webhook-types: - - organization - - business - app - membership-removed: + meta-deleted: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to a webhook itself. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. + description: The webhook was deleted. + operationId: meta/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header @@ -73072,7 +74561,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-meta-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73080,26 +74569,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: meta supported-webhook-types: - - organization + - marketplace - business + - repository + - organization - app - merge-group-checks-requested: + milestone-closed: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. - operationId: merge-group/checks-requested - tags: - - merge-queue + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was closed. + operationId: milestone/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73141,7 +74629,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-milestone-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73149,24 +74637,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: milestone supported-webhook-types: + - repository + - organization - app - merge-group-destroyed: + milestone-created: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. - operationId: merge-group/destroyed - tags: - - merge-queue + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was created. + operationId: milestone/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73208,7 +74695,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-milestone-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73216,19 +74703,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: milestone supported-webhook-types: + - repository + - organization - app - meta-deleted: + milestone-deleted: post: summary: |- - This event occurs when there is activity relating to a webhook itself. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. - description: The webhook was deleted. - operationId: meta/deleted + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was deleted. + operationId: milestone/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73270,7 +74761,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-milestone-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73278,14 +74769,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: meta + subcategory: milestone supported-webhook-types: - - marketplace - - business - repository - organization - app - milestone-closed: + milestone-edited: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. @@ -73293,8 +74782,8 @@ x-webhooks: If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was closed. - operationId: milestone/closed + description: A milestone was edited. + operationId: milestone/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: @@ -73338,7 +74827,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73351,7 +74840,7 @@ x-webhooks: - repository - organization - app - milestone-created: + milestone-opened: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. @@ -73359,8 +74848,8 @@ x-webhooks: If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was created. - operationId: milestone/created + description: A milestone was opened. + operationId: milestone/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: @@ -73404,7 +74893,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73417,18 +74906,18 @@ x-webhooks: - repository - organization - app - milestone-deleted: + org-block-blocked: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was deleted. - operationId: milestone/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A user was blocked from the organization. + operationId: org-block/blocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -73470,7 +74959,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-org-block-blocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73478,23 +74967,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - milestone-edited: + org-block-unblocked: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was edited. - operationId: milestone/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A previously blocked user was unblocked from the organization. + operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -73536,7 +75025,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-org-block-unblocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73544,23 +75033,79 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - milestone-opened: + organization-custom-property-created: post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was opened. - operationId: milestone/opened + summary: This event occurs when there is activity relating to an organization + custom property. + description: A new organization custom property was created. + operationId: organization-custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-organization-custom-property-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-deleted: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was deleted. + operationId: organization-custom-property/deleted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -73602,31 +75147,25 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: milestone + subcategory: organization_custom_property supported-webhook-types: - - repository - - organization - - app - org-block-blocked: + - business + organization-custom-property-updated: post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A user was blocked from the organization. - operationId: org-block/blocked + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was updated. + operationId: organization-custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -73668,31 +75207,25 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: org_block + subcategory: organization_custom_property supported-webhook-types: - - organization - business - - app - org-block-unblocked: + organization-custom-property-values-updated: post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A previously blocked user was unblocked from the organization. - operationId: org-block/unblocked + summary: This event occurs when there is activity relating to custom property + values for an organization. + description: The custom property values of an organization were updated. + operationId: organization-custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values parameters: - name: User-Agent in: header @@ -73734,18 +75267,18 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: org_block + subcategory: organization-custom-property-values supported-webhook-types: - - organization - business + - organization - app organization-deleted: post: @@ -84292,6 +85825,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -84468,6 +86008,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin enterprise_organization_installations: type: string description: The level of permission to grant the access token to manage @@ -86163,6 +87711,10 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest required: - id - size_gb @@ -86270,6 +87822,9 @@ components: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -86278,6 +87833,84 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -89100,6 +90733,51 @@ components: required: - date additionalProperties: true + copilot-usage-metrics-1-day-report: + type: object + title: Copilot Metrics 1 Day Report + description: Links to download the Copilot usage metrics report for an enterprise + for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the Copilot usage metrics report for the + enterprise for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + copilot-usage-metrics-28-day-report: + type: object + title: Copilot Metrics 28 Day Report + description: Links to download the latest Copilot usage metrics report for an + enterprise. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the latest Copilot usage metrics report + for the enterprise. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` format. + required: + - download_links + - report_start_day + - report_end_day dependabot-alert-package: type: object description: Details for the vulnerable package. @@ -89518,6 +91196,165 @@ components: - name - subnet_id - region + custom-property-base: + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete info about + this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + organization-custom-property: + title: Custom Property for Organization + description: Custom property defined for an organization + allOf: + - "$ref": "#/components/schemas/custom-property-base" + - type: object + properties: + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + organization-custom-property-payload: + title: Organization Custom Property Payload + description: Payload for creating or updating an organization custom property + definition on an enterprise. + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property. + description: + type: string + nullable: true + description: Short description of the property. + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property. + required: + - value_type + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + custom-properties-for-orgs-get-enterprise-property-values: + title: Enterprise Organization Custom Property Values + description: List of custom property values for an organization + type: object + properties: + organization_id: + type: integer + example: 1296269 + organization_login: + type: string + example: Hello-World + properties: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + description: List of custom property names and associated values + required: + - organization_id + - organization_login + - properties custom-property: title: Organization Custom Property description: Custom property defined on an organization @@ -89887,6 +91724,21 @@ components: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and repositories + by property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" repository-rule-creation: title: creation description: Only allow users with bypass permission to create matching refs. @@ -91584,19 +93436,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -94950,19 +96802,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -95562,6 +97414,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning campaign-summary: title: Campaign summary description: The campaign metadata and alert stats. @@ -99090,25 +100949,6 @@ components: - created_at - updated_at - archived_at - custom-property-value: - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -114139,19 +115979,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -153096,6 +154936,102 @@ components: - blocked_user - organization - sender + webhook-organization-custom-property-created: + title: organization custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: + "$ref": "#/components/schemas/organization-custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-deleted: + title: organization custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-updated: + title: organization custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/organization-custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + new_property_values: + type: array + description: The new custom property values. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - action + - organization + - enterprise + - new_property_values + - old_property_values webhook-organization-deleted: title: organization deleted event type: object @@ -223180,6 +225116,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -224367,6 +226331,19 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 + copilot-usage-metrics-1-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + copilot-usage-metrics-28-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' dependabot-alerts-for-organization: value: - number: 2 @@ -224730,6 +226707,65 @@ components: name: my_network_settings subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus + organization-custom-properties: + value: + properties: + - property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + - property_name: service + url: https://api.github.com/enterprises/github/org-properties/schema/service + source_type: enterprise + value_type: string + - property_name: team + url: https://api.github.com/enterprises/github/org-properties/schema/team + source_type: enterprise + value_type: string + description: Team owning the organization + organization-custom-property: + value: + property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + custom-properties-for-orgs-get-enterprise-property-values: + value: + - organization_id: 1296269 + organization_login: Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + custom-properties-for-orgs-patch-enterprise-property-values: + value: + organization_logins: + - acme + - github + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat custom-properties: value: - property_name: environment @@ -225190,6 +227226,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -226565,20 +228629,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization organization-custom-repository-role-example: value: id: 8030 @@ -226674,6 +228724,23 @@ components: teams_url: https://api.github.com/repos/octocat/example-repo/teams trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -227440,6 +229507,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -241374,23 +243447,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -250042,6 +252098,21 @@ components: required: true schema: type: string + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -250235,6 +252306,15 @@ components: required: true schema: type: integer + day: + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + example: '2025-10-13' dependabot-alert-comma-separated-states: name: state in: query @@ -250320,31 +252400,6 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 username: name: username description: The handle for the GitHub user account. @@ -250464,6 +252519,17 @@ components: enum: - code_security - secret_protection + cost-center-state: + name: state + in: query + description: Set to `active` or `deleted` to only list cost centers in a specific + state. + required: false + schema: + type: string + enum: + - active + - deleted cost-center: name: cost_center_id description: The ID corresponding to the cost center. diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 551749c44..96b267093 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -188,6 +188,10 @@ "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." @@ -2497,6 +2501,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -2517,6 +2526,11 @@ "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean", "default": false + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -2568,6 +2582,281 @@ } } }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an enterprise", + "description": "List custom images for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get an enterprise custom image definition for GitHub Actions Hosted Runners", + "description": "Get an enterprise custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the enterprise", + "description": "Delete a custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an enterprise", + "description": "List image versions of a custom image for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of an enterprise custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the enterprise", + "description": "Delete an image version of custom image from the enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an enterprise", @@ -2934,6 +3223,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -8667,6 +8961,216 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": { + "get": { + "summary": "Get Copilot enterprise usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": { + "get": { + "summary": "Get Copilot enterprise usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nOnly enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOnly enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -8716,12 +9220,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -9262,6 +9760,441 @@ } } }, + "/enterprises/{enterprise}/org-properties/schema": { + "get": { + "summary": "Get organization custom properties schema for an enterprise", + "description": "Gets all organization custom property definitions that are defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update organization custom property definitions on an enterprise", + "description": "Creates new or updates existing organization custom properties defined on an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of organization custom properties to create or update.", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": { + "get": { + "summary": "Get an organization custom property definition from an enterprise", + "description": "Gets an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "put": { + "summary": "Create or update an organization custom property definition on an enterprise", + "description": "Creates a new or updates an existing organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property-payload" + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "delete": { + "summary": "Remove an organization custom property definition from an enterprise", + "description": "Removes an organization custom property definition that is defined on an enterprise.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"manage enterprise custom properties for organizations\" fine-grained permission", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, + "/enterprises/{enterprise}/org-properties/values": { + "get": { + "summary": "List custom property values for organizations in an enterprise", + "description": "Lists enterprise organizations with all of their custom property values.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope\n- Actors with the enterprise-level \"read enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-get-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-properties-for-orgs-get-enterprise-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties-for-orgs-get-enterprise-property-values" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for organizations in an enterprise", + "description": "Create or update custom property values for organizations in an enterprise.\n\nTo remove a custom property value from an organization, set the property value to `null`.\n\nAccess requirements:\n- Enterprise admins\n- OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope\n- Actors with the enterprise-level \"edit enterprise custom properties for organizations\" fine-grained permission or above", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization_logins": { + "type": "array", + "description": "The names of organizations that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the organizations.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "organization_logins", + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties-for-orgs-patch-enterprise-property-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", @@ -10211,7 +11144,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -10518,6 +11451,9 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center-state" } ], "responses": { @@ -11109,7 +12045,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -11475,6 +12411,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -11874,6 +12820,336 @@ } } }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", @@ -11971,6 +13247,16 @@ ], "default": "disabled" }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, "group_id": { "nullable": true, "type": "string", @@ -15395,10 +16681,125 @@ } } }, + "/organizations/{org}/org-properties/values": { + "get": { + "summary": "Get all custom property values for an organization", + "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + }, + "patch": { + "summary": "Create or update custom property values for an organization", + "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the organization.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties-for-orgs" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -16053,6 +17454,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -16071,6 +17477,11 @@ "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false } }, "required": [ @@ -16123,6 +17534,281 @@ } } }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", @@ -16489,6 +18175,11 @@ "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true } } }, @@ -21009,6 +22700,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -21710,7 +23472,8 @@ "repository_id", "alert_numbers" ] - } + }, + "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", @@ -21721,8 +23484,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -25482,12 +27256,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -32682,16 +34450,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } }, { @@ -32868,16 +34642,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -55472,16 +57252,6 @@ { "$ref": "#/components/parameters/direction" }, - { - "name": "page", - "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -55497,12 +57267,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -73086,7 +74850,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "secret-scanning" ], @@ -88519,16 +90283,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -88696,16 +90466,22 @@ }, { "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", "in": "query", "required": false, "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "example": "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] } } ], @@ -89249,7 +91025,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -90382,11 +92158,104 @@ } } }, - "bypass-request-push-ruleset-created": { + "bypass-request-push-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_push_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-push-ruleset-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass request was created.", - "operationId": "exemption-request-push-ruleset/created", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, @@ -90453,7 +92322,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -90475,11 +92344,11 @@ } } }, - "bypass-request-push-ruleset-response-dismissed": { + "bypass-request-push-ruleset-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass response was dismissed.", - "operationId": "exemption-request-push-ruleset/response-dismissed", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, @@ -90546,7 +92415,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -90568,13 +92437,13 @@ } } }, - "bypass-request-push-ruleset-response-submitted": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", - "operationId": "exemption-request-push-ruleset/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -90639,7 +92508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -90652,7 +92521,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "bypass_request_push_ruleset", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -90661,11 +92530,11 @@ } } }, - "bypass-request-secret-scanning-cancelled": { + "bypass-request-secret-scanning-completed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass request was cancelled.", - "operationId": "exemption-request-secret-scanning/cancelled", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90732,7 +92601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -90754,11 +92623,11 @@ } } }, - "bypass-request-secret-scanning-completed": { + "bypass-request-secret-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning bypass request was completed.", - "operationId": "exemption-request-secret-scanning/completed", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90825,7 +92694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -90847,11 +92716,11 @@ } } }, - "bypass-request-secret-scanning-created": { + "bypass-request-secret-scanning-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass request was created.", - "operationId": "exemption-request-secret-scanning/created", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -90918,7 +92787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -90940,11 +92809,11 @@ } } }, - "bypass-request-secret-scanning-response-dismissed": { + "bypass-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A secret scanning push protection bypass response was dismissed.", - "operationId": "exemption-request-secret-scanning/response-dismissed", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, @@ -91011,7 +92880,224 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-created": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A new check run was created.", + "operationId": "check-run/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -91022,9 +93108,10 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "bypass_request_secret_scanning", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -91033,13 +93120,13 @@ } } }, - "bypass-request-secret-scanning-response-submitted": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", - "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", - "operationId": "exemption-request-secret-scanning/response-submitted", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -91104,7 +93191,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -91115,9 +93217,10 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "bypass_request_secret_scanning", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -91126,11 +93229,11 @@ } } }, - "check-run-completed": { + "check-run-rerequested": { "post": { "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, @@ -91197,21 +93300,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" + "$ref": "#/components/schemas/webhook-check-run-rerequested" }, "examples": { "default": { - "$ref": "#/components/examples/check-run-completed" + "$ref": "#/components/examples/check-run-rerequested" } } }, "application/x-www-form-urlencoded": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" }, "examples": { "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" + "$ref": "#/components/examples/check-run-rerequested-form-encoded" } } } @@ -91235,13 +93338,13 @@ } } }, - "check-run-created": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91306,22 +93409,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -91333,9 +93421,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -91344,13 +93431,13 @@ } } }, - "check-run-requested-action": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91415,22 +93502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -91442,9 +93514,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -91453,13 +93524,13 @@ } } }, - "check-run-rerequested": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -91524,22 +93595,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-appeared-in-branch": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -91551,9 +93700,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91562,13 +93710,13 @@ } } }, - "check-suite-completed": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91633,7 +93781,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -91646,7 +93794,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91655,13 +93803,13 @@ } } }, - "check-suite-requested": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91726,7 +93874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -91739,7 +93887,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91748,13 +93896,13 @@ } } }, - "check-suite-rerequested": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -91819,7 +93967,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -91832,7 +93980,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -91841,11 +93989,11 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -91912,7 +94060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -91934,11 +94082,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -92005,7 +94153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -92027,13 +94175,13 @@ } } }, - "code-scanning-alert-created": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -92098,7 +94246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -92111,7 +94259,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -92120,13 +94268,198 @@ } } }, - "code-scanning-alert-fixed": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-create" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "create", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "custom-property-created": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92191,7 +94524,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } @@ -92204,22 +94537,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "code-scanning-alert-reopened": { + "custom-property-promoted-to-enterprise": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\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 previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92284,7 +94617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" } } } @@ -92297,22 +94630,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "code-scanning-alert-reopened-by-user": { + "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -92377,7 +94710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-custom-property-updated" } } } @@ -92390,22 +94723,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "commit-comment-created": { + "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -92470,7 +94803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } @@ -92483,7 +94816,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "custom-property-values", "supported-webhook-types": [ "repository", "organization", @@ -92492,12 +94825,12 @@ } } }, - "create": { + "delete": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -92562,7 +94895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -92575,7 +94908,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -92584,106 +94917,13 @@ } } }, - "custom-property-created": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A new custom property was created.", - "operationId": "custom-property/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "business", - "organization", - "app" - ] - } - } - }, - "custom-property-deleted": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was deleted.", - "operationId": "custom-property/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92748,7 +94988,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -92761,22 +95001,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-promoted-to-enterprise": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was promoted to an enterprise.", - "operationId": "custom-property/promote-to-enterprise", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92841,7 +95081,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -92854,22 +95094,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-updated": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was updated.", - "operationId": "custom-property/updated", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -92934,7 +95174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -92947,22 +95187,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "dependabot_alert", "supported-webhook-types": [ - "business", + "repository", "organization", "app" ] } } }, - "custom-property-values-updated": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "The custom property values of a repository were updated.", - "operationId": "custom-property-values/updated", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -93027,7 +95267,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -93040,7 +95280,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom-property-values", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -93049,12 +95289,13 @@ } } }, - "delete": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -93119,7 +95360,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -93132,7 +95373,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -93141,11 +95382,11 @@ } } }, - "dependabot-alert-auto-dismissed": { + "dependabot-alert-reintroduced": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", - "operationId": "dependabot-alert/auto-dismissed", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -93212,7 +95453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -93234,11 +95475,11 @@ } } }, - "dependabot-alert-auto-reopened": { + "dependabot-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", - "operationId": "dependabot-alert/auto-reopened", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -93305,7 +95546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -93327,13 +95568,13 @@ } } }, - "dependabot-alert-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -93398,7 +95639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -93411,7 +95652,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -93420,13 +95661,13 @@ } } }, - "dependabot-alert-dismissed": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -93491,7 +95732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -93504,7 +95745,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -93513,13 +95754,13 @@ } } }, - "dependabot-alert-fixed": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -93584,7 +95825,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -93597,7 +95838,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -93606,13 +95847,13 @@ } } }, - "dependabot-alert-reintroduced": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -93677,7 +95918,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -93690,22 +95931,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dependabot-alert-reopened": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93770,7 +96009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -93783,22 +96022,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deploy-key-created": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93863,7 +96100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -93876,22 +96113,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deploy-key-deleted": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -93956,7 +96191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -93969,7 +96204,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -93978,13 +96304,13 @@ } } }, - "deployment-created": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94049,7 +96375,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -94062,7 +96388,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -94071,13 +96397,13 @@ } } }, - "deployment-protection-rule-requested": { + "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94142,7 +96468,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -94155,20 +96481,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-approved": { + "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -94190,7 +96518,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -94233,7 +96561,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -94246,20 +96574,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94324,7 +96654,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -94337,20 +96667,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94415,7 +96747,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -94428,20 +96760,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -94506,7 +96840,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -94519,7 +96853,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -94528,11 +96862,11 @@ } } }, - "discussion-answered": { + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -94599,7 +96933,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -94621,11 +96955,11 @@ } } }, - "discussion-category-changed": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -94692,7 +97026,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -94714,200 +97048,14 @@ } } }, - "discussion-closed": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "discussions", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-created": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "discussion_comment", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "discussion-comment-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" - }, "parameters": [ { "name": "User-Agent", @@ -94971,7 +97119,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -94984,7 +97132,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -94993,13 +97141,13 @@ } } }, - "discussion-comment-edited": { + "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -95064,7 +97212,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -95077,7 +97225,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -95086,11 +97234,11 @@ } } }, - "discussion-created": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95157,7 +97305,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -95179,11 +97327,11 @@ } } }, - "discussion-deleted": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95250,7 +97398,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -95272,11 +97420,11 @@ } } }, - "discussion-edited": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95300,7 +97448,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -95343,7 +97491,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -95365,11 +97513,11 @@ } } }, - "discussion-labeled": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95436,7 +97584,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -95458,11 +97606,11 @@ } } }, - "discussion-locked": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95529,7 +97677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -95551,11 +97699,11 @@ } } }, - "discussion-pinned": { + "discussion-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95622,7 +97770,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -95644,11 +97792,11 @@ } } }, - "discussion-reopened": { + "discussion-unlocked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95672,7 +97820,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -95715,7 +97863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -95737,11 +97885,11 @@ } } }, - "discussion-transferred": { + "discussion-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -95808,7 +97956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -95830,13 +97978,13 @@ } } }, - "discussion-unanswered": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -95901,7 +98049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -95912,9 +98060,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -95923,13 +98071,13 @@ } } }, - "discussion-unlabeled": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "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": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -95994,7 +98142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -96005,9 +98153,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96016,13 +98164,13 @@ } } }, - "discussion-unlocked": { + "dismissal-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was canceled.", + "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96087,7 +98235,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -96098,9 +98246,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96109,13 +98257,13 @@ } } }, - "discussion-unpinned": { + "dismissal-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was completed.", + "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96180,7 +98328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -96191,9 +98339,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96202,13 +98350,13 @@ } } }, - "dismissal-request-code-scanning-created": { + "dismissal-request-secret-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.", - "description": "A code scanning alert dismissal request was created.", - "operationId": "dismissal-request-code-scanning/created", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was created.", + "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96286,7 +98434,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96295,13 +98443,13 @@ } } }, - "dismissal-request-code-scanning-response-submitted": { + "dismissal-request-secret-scanning-response-dismissed": { "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.", - "description": "A code scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-code-scanning/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal response was dismissed.", + "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -96366,7 +98514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -96379,7 +98527,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -96388,11 +98536,11 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "dismissal-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "description": "A secret scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -96459,7 +98607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -96481,13 +98629,12 @@ } } }, - "dismissal-request-secret-scanning-completed": { + "fork": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was completed.", - "operationId": "dismissal-request-secret-scanning/completed", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -96552,7 +98699,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -96563,10 +98710,11 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "fork", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96574,13 +98722,13 @@ } } }, - "dismissal-request-secret-scanning-created": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was created.", - "operationId": "dismissal-request-secret-scanning/created", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -96645,7 +98793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -96656,24 +98804,21 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "github_app_authorization", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dismissal-request-secret-scanning-response-dismissed": { + "gollum": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was dismissed.", - "operationId": "dismissal-request-secret-scanning/response-dismissed", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -96738,7 +98883,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -96749,9 +98894,9 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "gollum", "supported-webhook-types": [ "repository", "organization", @@ -96760,13 +98905,13 @@ } } }, - "dismissal-request-secret-scanning-response-submitted": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-secret-scanning/response-submitted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -96831,7 +98976,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -96842,23 +98987,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "fork": { + "installation-deleted": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -96923,7 +99067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -96936,23 +99080,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "installation", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "github-app-authorization-revoked": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -97017,7 +99158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -97030,19 +99171,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "gollum": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -97107,7 +99249,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -97120,22 +99262,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "installation-created": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -97200,7 +99340,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -97213,18 +99353,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "installation-deleted": { + "installation-suspend": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -97291,7 +99431,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -97311,13 +99451,13 @@ } } }, - "installation-new-permissions-accepted": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -97382,7 +99522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -97395,20 +99535,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_target", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-added": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -97473,7 +99613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -97486,20 +99626,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-removed": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97564,7 +99704,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -97577,20 +99717,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-suspend": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97655,7 +99797,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -97668,20 +99810,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-target-renamed": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -97746,7 +99890,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -97759,20 +99903,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-unsuspend": { + "issue-dependencies-blocked-by-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -97837,7 +99983,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -97850,20 +99996,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue-dependencies", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "issue-dependencies-blocked-by-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocked by relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -97928,7 +100076,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -97941,7 +100089,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -97950,13 +100098,13 @@ } } }, - "issue-comment-deleted": { + "issue-dependencies-blocking-added": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -98021,7 +100169,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -98034,7 +100182,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -98043,13 +100191,13 @@ } } }, - "issue-comment-edited": { + "issue-dependencies-blocking-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -98114,7 +100262,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -98127,7 +100275,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -98136,13 +100284,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98207,7 +100355,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -98220,7 +100368,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98229,13 +100377,13 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocked by relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocked-by-removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98300,7 +100448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -98313,7 +100461,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98322,13 +100470,13 @@ } } }, - "issue-dependencies-blocking-added": { + "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98393,7 +100541,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -98406,7 +100554,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98415,13 +100563,13 @@ } } }, - "issue-dependencies-blocking-removed": { + "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -98486,7 +100634,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -98499,7 +100647,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -98508,11 +100656,11 @@ } } }, - "issues-assigned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98579,7 +100727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -98601,11 +100749,11 @@ } } }, - "issues-closed": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98672,7 +100820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -98694,11 +100842,11 @@ } } }, - "issues-deleted": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98765,7 +100913,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -98787,11 +100935,11 @@ } } }, - "issues-demilestoned": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98858,7 +101006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -98880,11 +101028,11 @@ } } }, - "issues-edited": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -98951,7 +101099,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -98973,11 +101121,11 @@ } } }, - "issues-labeled": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99044,7 +101192,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -99066,11 +101214,11 @@ } } }, - "issues-locked": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99137,7 +101285,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -99159,11 +101307,11 @@ } } }, - "issues-milestoned": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99230,7 +101378,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -99252,11 +101400,11 @@ } } }, - "issues-opened": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99323,7 +101471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -99345,11 +101493,11 @@ } } }, - "issues-pinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99416,7 +101564,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -99438,11 +101586,11 @@ } } }, - "issues-reopened": { + "issues-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99509,7 +101657,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -99531,11 +101679,11 @@ } } }, - "issues-transferred": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99602,7 +101750,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -99624,11 +101772,11 @@ } } }, - "issues-typed": { + "issues-unpinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99695,7 +101843,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -99717,11 +101865,11 @@ } } }, - "issues-unassigned": { + "issues-untyped": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99788,7 +101936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-untyped" } } } @@ -99810,13 +101958,13 @@ } } }, - "issues-unlabeled": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -99881,7 +102029,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -99894,7 +102042,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -99903,13 +102051,13 @@ } } }, - "issues-unlocked": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -99974,7 +102122,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -99987,7 +102135,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -99996,13 +102144,13 @@ } } }, - "issues-unpinned": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -100067,7 +102215,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -100080,7 +102228,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -100089,13 +102237,13 @@ } } }, - "issues-untyped": { + "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100160,7 +102308,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -100173,22 +102321,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-created": { + "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100253,7 +102399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -100266,22 +102412,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-deleted": { + "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100346,7 +102490,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -100359,22 +102503,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-edited": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -100439,7 +102581,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -100452,20 +102594,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "marketplace-purchase-cancelled": { + "marketplace-purchase-purchased": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -100532,7 +102672,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -100552,13 +102692,13 @@ } } }, - "marketplace-purchase-changed": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100623,7 +102763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -100636,20 +102776,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100714,7 +102857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -100727,20 +102870,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change-cancelled": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -100805,7 +102951,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -100818,20 +102964,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-purchased": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -100896,7 +103045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -100909,20 +103058,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "membership", "supported-webhook-types": [ - "marketplace" + "organization", + "business", + "app" ] } } }, - "member-added": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -100987,7 +103138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -101000,23 +103151,25 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "membership", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "member-edited": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -101081,7 +103234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -101094,23 +103247,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "merge_group", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "member-removed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -101175,7 +103328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -101188,23 +103341,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "merge_group", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "membership-added": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -101269,7 +103419,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -101282,22 +103432,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "meta", "supported-webhook-types": [ - "organization", + "marketplace", "business", + "repository", + "organization", "app" ] } } }, - "membership-removed": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101362,7 +103514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -101375,25 +103527,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "merge-group-checks-requested": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101458,7 +103607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -101471,23 +103620,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "merge-group-destroyed": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101552,7 +103700,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -101565,20 +103713,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "meta-deleted": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -101643,7 +103793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -101656,10 +103806,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "milestone", "supported-webhook-types": [ - "marketplace", - "business", "repository", "organization", "app" @@ -101667,11 +103815,11 @@ } } }, - "milestone-closed": { + "milestone-opened": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -101738,7 +103886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -101760,13 +103908,106 @@ } } }, - "milestone-created": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-blocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "org-block-unblocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -101831,7 +104072,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -101844,22 +104085,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-deleted": { + "organization-custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "A new organization custom property was created.", + "operationId": "organization-custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -101924,7 +104165,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } @@ -101935,24 +104176,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "milestone-edited": { + "organization-custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was deleted.", + "operationId": "organization-custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102017,7 +104256,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } @@ -102028,24 +104267,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "milestone-opened": { + "organization-custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was updated.", + "operationId": "organization-custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102110,7 +104347,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } @@ -102121,24 +104358,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "org-block-blocked": { + "organization-custom-property-values-updated": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to custom property values for an organization.", + "description": "The custom property values of an organization were updated.", + "operationId": "organization-custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -102203,7 +104438,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } @@ -102214,105 +104449,12 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization-custom-property-values", "supported-webhook-types": [ - "organization", "business", - "app" - ] - } - } - }, - "org-block-unblocked": { - "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "org_block", - "supported-webhook-types": [ "organization", - "business", "app" ] } @@ -116949,6 +119091,14 @@ "write" ] }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", @@ -117147,6 +119297,15 @@ "write" ] }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", @@ -119210,6 +121369,11 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" } }, "required": [ @@ -119342,6 +121506,10 @@ "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -119354,6 +121522,102 @@ "platform" ] }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, "actions-hosted-runner-curated-image": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", @@ -122834,6 +125098,60 @@ ], "additionalProperties": true }, + "copilot-usage-metrics-1-day-report": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "copilot-usage-metrics-28-day-report": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, "dependabot-alert-package": { "type": "object", "description": "Details for the vulnerable package.", @@ -123350,6 +125668,224 @@ "region" ] }, + "custom-property-base": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + } + }, + "organization-custom-property": { + "title": "Custom Property for Organization", + "description": "Custom property defined for an organization", + "allOf": [ + { + "$ref": "#/components/schemas/custom-property-base" + }, + { + "type": "object", + "properties": { + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + ] + }, + "organization-custom-property-payload": { + "title": "Organization Custom Property Payload", + "description": "Payload for creating or updating an organization custom property definition on an enterprise.", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property." + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property." + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property." + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors" + ], + "example": "enterprise_actors", + "description": "Who can edit the values of the property." + } + }, + "required": [ + "value_type" + ] + }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "custom-properties-for-orgs-get-enterprise-property-values": { + "title": "Enterprise Organization Custom Property Values", + "description": "List of custom property values for an organization", + "type": "object", + "properties": { + "organization_id": { + "type": "integer", + "example": 1296269 + }, + "organization_login": { + "type": "string", + "example": "Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "organization_id", + "organization_login", + "properties" + ] + }, "custom-property": { "title": "Organization Custom Property", "description": "Custom property defined on an organization", @@ -123833,6 +126369,38 @@ "$ref": "#/components/schemas/repository-ruleset-conditions" } ] + }, + { + "type": "object", + "title": "organization_property_and_repository_name", + "description": "Conditions to target organizations by property and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] + }, + { + "type": "object", + "title": "organization_property_and_repository_property", + "description": "Conditions to target organizations by property and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] } ] }, @@ -126121,7 +128689,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -126129,7 +128697,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -126137,7 +128705,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -130503,7 +133071,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -130511,7 +133079,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -130519,7 +133087,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -131222,6 +133790,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "campaign-summary": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", @@ -135656,36 +138233,6 @@ "archived_at" ] }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "nullable": true - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -155368,7 +157915,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -155376,7 +157923,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -155384,7 +157931,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -207464,6 +210011,144 @@ "sender" ] }, + "webhook-organization-custom-property-created": { + "title": "organization custom property created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "definition": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-deleted": { + "title": "organization custom property deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "definition": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property that was deleted." + } + }, + "required": [ + "property_name" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-updated": { + "title": "organization custom property updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "definition": { + "$ref": "#/components/schemas/organization-custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition", + "enterprise" + ] + }, + "webhook-organization-custom-property-values-updated": { + "title": "Custom property values updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "new_property_values": { + "type": "array", + "description": "The new custom property values.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "old_property_values": { + "type": "array", + "description": "The old custom property values.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "action", + "organization", + "enterprise", + "new_property_values", + "old_property_values" + ] + }, "webhook-organization-deleted": { "title": "organization deleted event", "type": "object", @@ -299242,6 +301927,45 @@ "last_active_on": "2022-10-09T23:39:01Z" } }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, "actions-hosted-runner-curated-image": { "value": { "id": "ubuntu-20.04", @@ -300770,6 +303494,25 @@ } ] }, + "copilot-usage-metrics-1-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + }, + "copilot-usage-metrics-28-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + }, "dependabot-alerts-for-organization": { "value": [ { @@ -301236,6 +303979,99 @@ "region": "eastus" } }, + "organization-custom-properties": { + "value": { + "properties": [ + { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/enterprises/github/org-properties/schema/service", + "source_type": "enterprise", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/enterprises/github/org-properties/schema/team", + "source_type": "enterprise", + "value_type": "string", + "description": "Team owning the organization" + } + ] + } + }, + "organization-custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/enterprises/github/org-properties/schema/environment", + "source_type": "enterprise", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "enterprise_actors" + } + }, + "custom-properties-for-orgs-get-enterprise-property-values": { + "value": [ + { + "organization_id": 1296269, + "organization_login": "Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + }, + "custom-properties-for-orgs-patch-enterprise-property-values": { + "value": { + "organization_logins": [ + "acme", + "github" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "custom-properties": { "value": [ { @@ -301832,6 +304668,40 @@ "site_admin": false } }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, "public-events-items": { "value": [ { @@ -303352,24 +306222,6 @@ "octocat": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" }, - "organization-simple-items": { - "value": [ - { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - } - ] - }, "organization-custom-repository-role-example": { "value": { "id": 8030, @@ -303475,6 +306327,40 @@ ] } }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -304378,6 +307264,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -320687,40 +323585,6 @@ } ] }, - "custom-property-values": { - "value": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - }, - "create-or-update-custom-properties-values": { - "value": { - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -330670,6 +333534,25 @@ "type": "string" } }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, "hosted-runner-id": { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", @@ -330885,6 +333768,17 @@ "type": "integer" } }, + "day": { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -330972,29 +333866,6 @@ "default": "created" } }, - "pagination-first": { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - "pagination-last": { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } - }, "username": { "name": "username", "description": "The handle for the GitHub user account.", @@ -331128,6 +333999,19 @@ ] } }, + "cost-center-state": { + "name": "state", + "in": "query", + "description": "Set to `active` or `deleted` to only list cost centers in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ] + } + }, "cost-center": { "name": "cost_center_id", "description": "The ID corresponding to the cost center.", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 42a740559..8191f02ba 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -99,6 +99,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries @@ -1748,6 +1750,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -1767,6 +1774,11 @@ paths: `GET actions/hosted-runners/limits` type: boolean default: false + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -1797,6 +1809,199 @@ paths: githubCloudOnly: true category: actions subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an enterprise + description: |- + List custom images for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get an enterprise custom image definition for GitHub Actions Hosted + Runners + description: |- + Get an enterprise custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the enterprise + description: |- + Delete a custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an enterprise + description: |- + List image versions of a custom image for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of an enterprise custom image for GitHub Actions + Hosted Runners + description: |- + Get an image version of an enterprise custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the enterprise + description: |- + Delete an image version of custom image from the enterprise. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an enterprise @@ -2053,6 +2258,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -6187,6 +6397,168 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": + get: + summary: Get Copilot enterprise usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-enterprise-usage-metrics + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Only enterprise owners and billing managers can retrieve Copilot user metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows enterprise administrators to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Only enterprise owners and billing managers can retrieve Copilot users metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-users-usage-metrics + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -6217,8 +6589,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -6591,6 +6961,338 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations + "/enterprises/{enterprise}/org-properties/schema": + get: + summary: Get organization custom properties schema for an enterprise + description: |- + Gets all organization custom property definitions that are defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update organization custom property definitions on an enterprise + description: |- + Creates new or updates existing organization custom properties defined on an enterprise in a batch. + + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of organization custom properties to create + or update. + items: + "$ref": "#/components/schemas/organization-custom-property" + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": + get: + summary: Get an organization custom property definition from an enterprise + description: |- + Gets an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + put: + summary: Create or update an organization custom property definition on an enterprise + description: |- + Creates a new or updates an existing organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property-payload" + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-property" + examples: + default: + "$ref": "#/components/examples/organization-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + delete: + summary: Remove an organization custom property definition from an enterprise + description: |- + Removes an organization custom property definition that is defined on an enterprise. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '204': + "$ref": "#/components/responses/no_content" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + "/enterprises/{enterprise}/org-properties/values": + get: + summary: List custom property values for organizations in an enterprise + description: |- + Lists enterprise organizations with all of their custom property values. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope + - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-properties-for-orgs-get-enterprise-property-values" + examples: + default: + "$ref": "#/components/examples/custom-properties-for-orgs-get-enterprise-property-values" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for organizations in an enterprise + description: |- + Create or update custom property values for organizations in an enterprise. + + To remove a custom property value from an organization, set the property value to `null`. + + Access requirements: + - Enterprise admins + - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope + - Actors with the enterprise-level "edit enterprise custom properties for organizations" fine-grained permission or above + tags: + - enterprise-admin + operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + organization_logins: + type: array + description: The names of organizations that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the organizations. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - organization_logins + - properties + examples: + default: + "$ref": "#/components/examples/custom-properties-for-orgs-patch-enterprise-property-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/properties/schema": get: summary: Get custom properties for an enterprise @@ -7219,7 +7921,7 @@ paths: '503': "$ref": "#/components/responses/service_unavailable" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -7436,6 +8138,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/cost-center-state" responses: '200': "$ref": "#/components/responses/get_all_cost_centers" @@ -7842,8 +8545,10 @@ paths: "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise - description: Gets a report of premium request usage for an enterprise. To use - this endpoint, you must be an administrator or billing manager of the enterprise. + description: |- + Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe @@ -8111,6 +8816,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -8357,6 +9074,209 @@ paths: enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team @@ -8430,6 +9350,18 @@ paths: - all - disabled default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled group_id: nullable: true type: string @@ -10864,12 +11796,107 @@ paths: enabledForGitHubApps: true category: dependabot subcategory: repository-access + "/organizations/{org}/org-properties/values": + get: + summary: Get all custom property values for an organization + description: |- + Gets all custom property values that are set for an organization. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `read:org` scope + - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs + patch: + summary: Create or update custom property values for an organization + description: |- + Create new or update existing custom property values for an organization. + To remove a custom property value from an organization, set the property value to `null`. + + The organization must belong to an enterprise. + + Access requirements: + - Organization admins + - OAuth tokens and personal access tokens (classic) with the `admin:org` scope + - Actors with the organization-level "edit custom properties for an organization" fine-grained permission + tags: + - orgs + operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the organization. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -11435,6 +12462,11 @@ paths: - github - partner - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -11452,6 +12484,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -11483,6 +12520,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -11739,6 +12967,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true examples: default: value: @@ -15033,6 +16266,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -15523,6 +16803,7 @@ paths: required: - repository_id - alert_numbers + nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. @@ -15532,7 +16813,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -18381,8 +19666,6 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -23518,16 +24801,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" @@ -23639,16 +24925,19 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -40171,14 +41460,6 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - description: "**Closing down notice**. Page number of the results to fetch. - Use cursor-based pagination with `before` or `after` instead." - deprecated: true - in: query - schema: - type: integer - default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -40189,8 +41470,6 @@ paths: default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -52803,6 +54082,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -63913,16 +65195,19 @@ paths: schema: type: string - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64030,16 +65315,19 @@ paths: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields - description: Limit results to specific fields, by their IDs. If not specified, - the title field will be returned. + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: - type: array - maxItems: 50 - items: - type: string - example: fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64400,7 +65688,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -65844,16 +67135,182 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-created" + "$ref": "#/components/schemas/webhook-check-run-created" + examples: + default: + "$ref": "#/components/examples/check-run-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/check-run-created-form-encoded" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: check_run + supported-webhook-types: + - repository + - organization + - app + check-run-requested-action: + post: + summary: |- + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + + For activity relating to check suites, use the `check-suite` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + + Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: A check run completed, and someone requested a followup action + that your app provides. Only the GitHub App someone requests to perform an + action will receive the `requested_action` payload. For more information, + see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." + operationId: check-run/requested-action + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-check-run-requested-action" + examples: + default: + "$ref": "#/components/examples/check-run-requested-action" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + examples: + default: + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: check_run + supported-webhook-types: + - repository + - organization + - app + check-run-rerequested: + post: + summary: |- + This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + + For activity relating to check suites, use the `check-suite` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + + Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: Someone requested to re-run a check run. Only the GitHub App that + someone requests to re-run the check will receive the `rerequested` payload. + operationId: check-run/rerequested + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-check-run-rerequested" examples: default: - "$ref": "#/components/examples/check-run-created" + "$ref": "#/components/examples/check-run-rerequested" application/x-www-form-urlencoded: schema: - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" examples: default: - "$ref": "#/components/examples/check-run-created-form-encoded" + "$ref": "#/components/examples/check-run-rerequested-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65867,26 +67324,24 @@ x-webhooks: - repository - organization - app - check-run-requested-action: + check-suite-completed: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - For activity relating to check suites, use the `check-suite` event. + For activity relating to check runs, use the `check_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: A check run completed, and someone requested a followup action - that your app provides. Only the GitHub App someone requests to perform an - action will receive the `requested_action` payload. For more information, - see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." - operationId: check-run/requested-action + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: All check runs in a check suite have completed, and a conclusion + is available. + operationId: check-suite/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -65928,47 +67383,40 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-requested-action" - examples: - default: - "$ref": "#/components/examples/check-run-requested-action" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - examples: - default: - "$ref": "#/components/examples/check-run-requested-action-form-encoded" + "$ref": "#/components/schemas/webhook-check-suite-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: check_run + subcategory: check_suite supported-webhook-types: - repository - organization - app - check-run-rerequested: + check-suite-requested: post: summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - For activity relating to check suites, use the `check-suite` event. + For activity relating to check runs, use the `check_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. + Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run a check run. Only the GitHub App that - someone requests to re-run the check will receive the `rerequested` payload. - operationId: check-run/rerequested + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: Someone requested to run a check suite. By default, check suites + are automatically created when you create a check run. For more information, + see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" + in the REST API documentation. + operationId: check-suite/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header @@ -66010,30 +67458,20 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-run-rerequested" - examples: - default: - "$ref": "#/components/examples/check-run-rerequested" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - examples: - default: - "$ref": "#/components/examples/check-run-rerequested-form-encoded" + "$ref": "#/components/schemas/webhook-check-suite-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: check_run + subcategory: check_suite supported-webhook-types: - repository - organization - app - check-suite-completed: + check-suite-rerequested: post: summary: |- This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. @@ -66046,9 +67484,12 @@ x-webhooks: > [!NOTE] > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: All check runs in a check suite have completed, and a conclusion - is available. - operationId: check-suite/completed + description: Someone requested to re-run the check runs in a check suite. For + more information, see [the GraphQL API documentation for creating a check + suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: @@ -66092,7 +67533,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66105,27 +67546,18 @@ x-webhooks: - repository - organization - app - check-suite-requested: + code-scanning-alert-appeared-in-branch: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to run a check suite. By default, check suites - are automatically created when you create a check run. For more information, - see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) - or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" - in the REST API documentation. - operationId: check-suite/requested + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: A previously created code scanning alert appeared in another branch. + This can happen when a branch is merged into or created from a branch with + a pre-existing code scanning alert. + operationId: code-scanning-alert/appeared-in-branch externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -66167,7 +67599,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66175,32 +67607,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - check-suite-rerequested: + code-scanning-alert-closed-by-user: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run the check runs in a check suite. For - more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" - in the REST API documentation. - operationId: check-suite/rerequested + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: Someone closed a code scanning alert. + operationId: code-scanning-alert/closed-by-user externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -66242,7 +67663,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66250,21 +67671,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - code-scanning-alert-appeared-in-branch: + code-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously created code scanning alert appeared in another branch. - This can happen when a branch is merged into or created from a branch with - a pre-existing code scanning alert. - operationId: code-scanning-alert/appeared-in-branch + description: A code scanning alert was created in a repository. + operationId: code-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66308,7 +67727,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66321,14 +67740,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-closed-by-user: + code-scanning-alert-fixed: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone closed a code scanning alert. - operationId: code-scanning-alert/closed-by-user + description: A code scanning alert was fixed in a branch by a commit. + operationId: code-scanning-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66372,7 +67791,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66385,14 +67804,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-created: + code-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To 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 was created in a repository. - operationId: code-scanning-alert/created + description: A previously fixed code scanning alert reappeared in a branch. + operationId: code-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66436,7 +67855,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66449,14 +67868,14 @@ x-webhooks: - repository - organization - app - code-scanning-alert-fixed: + code-scanning-alert-reopened-by-user: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To 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 was fixed in a branch by a commit. - operationId: code-scanning-alert/fixed + description: Someone reopened a code scanning alert. + operationId: code-scanning-alert/reopened-by-user externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -66500,7 +67919,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66513,16 +67932,85 @@ x-webhooks: - repository - organization - app - code-scanning-alert-reopened: + commit-comment-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously fixed code scanning alert reappeared in a branch. - operationId: code-scanning-alert/reopened + For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: Someone commented on a commit. + operationId: commit-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-commit-comment-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: commit_comment + supported-webhook-types: + - repository + - organization + - app + create: + post: + summary: |- + This event occurs when a Git branch or tag is created. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + **Notes**: + - This event will not occur when more than three tags are created at once. + - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. + operationId: create + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header @@ -66564,7 +68052,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66572,21 +68060,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: create supported-webhook-types: - repository - organization - app - code-scanning-alert-reopened-by-user: + custom-property-created: post: summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone reopened a code scanning alert. - operationId: code-scanning-alert/reopened-by-user + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A new custom property was created. + operationId: custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66628,7 +68118,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66636,23 +68126,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - commit-comment-created: + custom-property-deleted: post: summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. + This event occurs when there is activity relating to a custom property. - For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: Someone commented on a commit. - operationId: commit-comment/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was deleted. + operationId: custom-property/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66694,7 +68184,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66702,24 +68192,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: commit_comment + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - create: + custom-property-promoted-to-enterprise: post: summary: |- - This event occurs when a Git branch or tag is created. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. - **Notes**: - - This event will not occur when more than three tags are created at once. - - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. - operationId: create + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -66761,7 +68250,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66769,12 +68258,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: create + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - custom-property-created: + custom-property-updated: post: summary: |- This event occurs when there is activity relating to a custom property. @@ -66782,8 +68271,8 @@ x-webhooks: For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A new custom property was created. - operationId: custom-property/created + description: A custom property was updated. + operationId: custom-property/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: @@ -66827,7 +68316,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-created" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66840,18 +68329,18 @@ x-webhooks: - business - organization - app - custom-property-deleted: + custom-property-values-updated: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when there is activity relating to custom property values for a repository. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was deleted. - operationId: custom-property/deleted + description: The custom property values of a repository were updated. + operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -66893,7 +68382,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-deleted" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66901,23 +68390,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: custom-property-values supported-webhook-types: - - business + - repository - organization - app - custom-property-promoted-to-enterprise: + delete: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including + branch and tag deletions, use the [`push`](#push) webhook event. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was promoted to an enterprise. - operationId: custom-property/promote-to-enterprise + > [!NOTE] + > This event will not occur when more than three tags are deleted at once. + operationId: delete externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -66959,7 +68449,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66967,23 +68457,27 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: delete supported-webhook-types: - - business + - repository - organization - app - custom-property-updated: + dependabot-alert-auto-dismissed: post: summary: |- - This event occurs when there is activity relating to a custom property. + This event occurs when there is activity relating to Dependabot alerts. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was updated. - operationId: custom-property/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67025,7 +68519,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67033,23 +68527,28 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom_property + subcategory: dependabot_alert supported-webhook-types: - - business + - repository - organization - app - custom-property-values-updated: + dependabot-alert-auto-reopened: post: summary: |- - This event occurs when there is activity relating to custom property values for a repository. + This event occurs when there is activity relating to Dependabot alerts. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: The custom property values of a repository were updated. - operationId: custom-property-values/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert, that had been automatically closed by a Dependabot + auto-triage rule, was automatically reopened because the alert metadata or + rule changed. + operationId: dependabot-alert/auto-reopened externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67091,7 +68590,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67099,24 +68598,28 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom-property-values + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - delete: + dependabot-alert-created: post: summary: |- - This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including - branch and tag deletions, use the [`push`](#push) webhook event. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > This event will not occur when more than three tags are deleted at once. - operationId: delete + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change introduced a vulnerable dependency, or a + GitHub Security Advisory was published and an existing dependency was found + to be vulnerable. + operationId: dependabot-alert/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -67158,7 +68661,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67166,12 +68669,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: delete + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - dependabot-alert-auto-dismissed: + dependabot-alert-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67182,9 +68685,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was automatically closed by a Dependabot auto-triage - rule. - operationId: dependabot-alert/auto-dismissed + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67228,7 +68730,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67241,7 +68743,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-auto-reopened: + dependabot-alert-fixed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67252,10 +68754,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert, that had been automatically closed by a Dependabot - auto-triage rule, was automatically reopened because the alert metadata or - rule changed. - operationId: dependabot-alert/auto-reopened + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67299,7 +68799,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67312,7 +68812,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-created: + dependabot-alert-reintroduced: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67323,10 +68823,9 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency, or a - GitHub Security Advisory was published and an existing dependency was found - to be vulnerable. - operationId: dependabot-alert/created + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67370,7 +68869,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67383,7 +68882,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-dismissed: + dependabot-alert-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -67394,8 +68893,8 @@ x-webhooks: > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -67439,7 +68938,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67452,21 +68951,16 @@ x-webhooks: - repository - organization - app - dependabot-alert-fixed: + deploy-key-created: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change removed a vulnerability. - operationId: dependabot-alert/fixed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deploy key was created. + operationId: deploy-key/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -67508,7 +69002,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-deploy-key-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67516,27 +69010,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deploy_key supported-webhook-types: - repository - organization - app - dependabot-alert-reintroduced: + deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency that - had previously been fixed. - operationId: dependabot-alert/reintroduced + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deploy key was deleted. + operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -67578,7 +69066,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67586,26 +69074,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deploy_key supported-webhook-types: - repository - organization - app - dependabot-alert-reopened: + deployment-created: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + For activity relating to deployment status, use the `deployment_status` event. - > [!NOTE] - > Webhook events for Dependabot alerts are currently in public preview and subject to change. - description: A Dependabot alert was manually reopened. - operationId: dependabot-alert/reopened + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment was created. + operationId: deployment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header @@ -67647,7 +69132,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deployment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67655,21 +69140,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: deployment supported-webhook-types: - repository - organization - app - deploy-key-created: + deployment-protection-rule-requested: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was created. - operationId: deploy-key/created + description: A deployment protection rule was requested for an environment. + operationId: deployment-protection-rule/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -67711,7 +69196,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67719,21 +69204,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: deployment_protection_rule supported-webhook-types: - - repository - - organization - app - deploy-key-deleted: + deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was deleted. - operationId: deploy-key/deleted + description: A deployment review was approved. + operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67775,7 +69260,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67783,23 +69268,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: deployment_review supported-webhook-types: - - repository - - organization - app - deployment-created: + deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment status, use the `deployment_status` event. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment was created. - operationId: deployment/created + description: A deployment review was rejected. + operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67841,7 +69324,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67849,21 +69332,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment + subcategory: deployment_review supported-webhook-types: - - repository - - organization - app - deployment-protection-rule-requested: + deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment protection rule was requested for an environment. - operationId: deployment-protection-rule/requested + description: A deployment review was requested. + operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header @@ -67905,7 +69388,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-deployment-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67913,21 +69396,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_protection_rule + subcategory: deployment_review supported-webhook-types: - app - deployment-review-approved: + deployment-status-created: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was approved. - operationId: deployment-review/approved + + > [!NOTE] + > A webhook event is not fired for deployment statuses with an `inactive` state. + description: A new deployment status was created. + operationId: deployment-status/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header @@ -67969,7 +69455,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-deployment-status-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67977,21 +69463,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: deployment_status supported-webhook-types: + - repository + - organization - app - deployment-review-rejected: + discussion-answered: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was rejected. - operationId: deployment-review/rejected + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A comment on the discussion was marked as the answer. + operationId: discussion/answered externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68033,7 +69524,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-discussion-answered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68041,21 +69532,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: discussion supported-webhook-types: + - repository + - organization - app - deployment-review-requested: + discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was requested. - operationId: deployment-review/requested + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: The category of a discussion was changed. + operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68097,7 +69593,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-discussion-category-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68105,24 +69601,95 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_review + subcategory: discussion supported-webhook-types: + - repository + - organization - app - deployment-status-created: + discussion-closed: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to deployment creation, use the `deployment` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > A webhook event is not fired for deployment statuses with an `inactive` state. - description: A new deployment status was created. - operationId: deployment-status/created + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A discussion was closed. + operationId: discussion/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: discussions + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-closed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + discussion-comment-created: + post: + summary: |- + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + > [!NOTE] + > Webhook events for GitHub Discussions are currently in public preview and subject to change. + description: A comment on a discussion was created. + operationId: discussion-comment/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68164,7 +69731,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68172,26 +69739,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment_status + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-answered: + discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was marked as the answer. - operationId: discussion/answered + description: A comment on a discussion was deleted. + operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68233,7 +69800,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68241,26 +69808,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-category-changed: + discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The category of a discussion was changed. - operationId: discussion/category-changed + description: A comment on a discussion was edited. + operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header @@ -68302,7 +69869,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68310,12 +69877,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion_comment supported-webhook-types: - repository - organization - app - discussion-closed: + discussion-created: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68326,8 +69893,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was closed. - operationId: discussion/closed + description: A discussion was created. + operationId: discussion/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68343,7 +69910,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -68371,7 +69938,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-discussion-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68384,21 +69951,21 @@ x-webhooks: - repository - organization - app - discussion-comment-created: + discussion-deleted: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was created. - operationId: discussion-comment/created + description: A discussion was deleted. + operationId: discussion/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68440,7 +70007,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68448,26 +70015,27 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-deleted: + discussion-edited: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was deleted. - operationId: discussion-comment/deleted + description: The title or body on a discussion was edited, or the category of + the discussion was changed. + operationId: discussion/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68509,7 +70077,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68517,26 +70085,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-edited: + discussion-labeled: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was edited. - operationId: discussion-comment/edited + description: A label was added to a discussion. + operationId: discussion/labeled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -68578,7 +70146,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68586,12 +70154,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion_comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-created: + discussion-locked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68602,8 +70170,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was created. - operationId: discussion/created + description: A discussion was locked. + operationId: discussion/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68647,7 +70215,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68660,7 +70228,7 @@ x-webhooks: - repository - organization - app - discussion-deleted: + discussion-pinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68671,8 +70239,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was deleted. - operationId: discussion/deleted + description: A discussion was pinned. + operationId: discussion/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68716,7 +70284,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68729,7 +70297,7 @@ x-webhooks: - repository - organization - app - discussion-edited: + discussion-reopened: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68740,9 +70308,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The title or body on a discussion was edited, or the category of - the discussion was changed. - operationId: discussion/edited + description: A discussion was reopened. + operationId: discussion/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68758,7 +70325,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -68786,7 +70353,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68799,7 +70366,7 @@ x-webhooks: - repository - organization - app - discussion-labeled: + discussion-transferred: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68810,8 +70377,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was added to a discussion. - operationId: discussion/labeled + description: A discussion was transferred to another repository. + operationId: discussion/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68855,7 +70422,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68868,7 +70435,7 @@ x-webhooks: - repository - organization - app - discussion-locked: + discussion-unanswered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68879,8 +70446,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was locked. - operationId: discussion/locked + description: A comment on the discussion was unmarked as the answer. + operationId: discussion/unanswered externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68924,7 +70491,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-unanswered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -68937,7 +70504,7 @@ x-webhooks: - repository - organization - app - discussion-pinned: + discussion-unlabeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -68948,8 +70515,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was pinned. - operationId: discussion/pinned + description: A label was removed from a discussion. + operationId: discussion/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -68993,7 +70560,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69006,7 +70573,7 @@ x-webhooks: - repository - organization - app - discussion-reopened: + discussion-unlocked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -69017,8 +70584,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was reopened. - operationId: discussion/reopened + description: A discussion was unlocked. + operationId: discussion/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -69034,7 +70601,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -69062,7 +70629,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69075,7 +70642,7 @@ x-webhooks: - repository - organization - app - discussion-transferred: + discussion-unpinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). @@ -69086,8 +70653,8 @@ x-webhooks: > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was transferred to another repository. - operationId: discussion/transferred + description: A discussion was unpinned. + operationId: discussion/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: @@ -69131,7 +70698,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69144,21 +70711,16 @@ x-webhooks: - repository - organization - app - discussion-unanswered: + dismissal-request-code-scanning-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was unmarked as the answer. - operationId: discussion/unanswered + To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -69200,34 +70762,29 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app - discussion-unlabeled: + dismissal-request-code-scanning-response-submitted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was removed from a discussion. - operationId: discussion/unlabeled + To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header @@ -69269,34 +70826,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app - discussion-unlocked: + dismissal-request-secret-scanning-cancelled: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unlocked. - operationId: discussion/unlocked + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was canceled. + operationId: dismissal-request-secret-scanning/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69338,34 +70893,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app - discussion-unpinned: + dismissal-request-secret-scanning-completed: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unpinned. - operationId: discussion/unpinned + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was completed. + operationId: dismissal-request-secret-scanning/completed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69407,29 +70960,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: discussion + subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app - dismissal-request-code-scanning-created: + dismissal-request-secret-scanning-created: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + [!NOTE] + Delegated alert dismissal for secret scanning is currently in public preview and subject to change. + description: A secret scanning alert dismissal request was created. + operationId: dismissal-request-secret-scanning/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header @@ -69476,137 +71032,6 @@ x-webhooks: '200': description: Return a 200 status to indicate that the data was received successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: dismissal_request_code_scanning - supported-webhook-types: - - repository - - organization - - app - 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. - - To 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: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: dismissal_request_code_scanning - supported-webhook-types: - - repository - - organization - - app - dismissal-request-secret-scanning-cancelled: - post: - summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was canceled. - operationId: dismissal-request-secret-scanning/cancelled - externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully x-github: githubCloudOnly: true category: webhooks @@ -69615,7 +71040,7 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-completed: + dismissal-request-secret-scanning-response-dismissed: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. @@ -69624,8 +71049,8 @@ x-webhooks: [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was completed. - operationId: dismissal-request-secret-scanning/completed + description: A secret scanning alert dismissal response was dismissed. + operationId: dismissal-request-secret-scanning/response-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: @@ -69669,7 +71094,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69682,7 +71107,7 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-created: + dismissal-request-secret-scanning-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. @@ -69691,8 +71116,8 @@ x-webhooks: [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal request was created. - operationId: dismissal-request-secret-scanning/created + description: A secret scanning alert dismissal response was submitted. + operationId: dismissal-request-secret-scanning/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: @@ -69736,7 +71161,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69749,19 +71174,15 @@ x-webhooks: - repository - organization - app - dismissal-request-secret-scanning-response-dismissed: + fork: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal response was dismissed. - operationId: dismissal-request-secret-scanning/response-dismissed + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: fork externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header @@ -69803,32 +71224,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-fork" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: true + githubCloudOnly: false category: webhooks - subcategory: dismissal_request_secret_scanning + subcategory: fork supported-webhook-types: + - business - repository - organization - app - dismissal-request-secret-scanning-response-submitted: + github-app-authorization-revoked: post: summary: |- - This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + A GitHub App receives this webhook by default and cannot unsubscribe from this event. - [!NOTE] - Delegated alert dismissal for secret scanning is currently in public preview and subject to change. - description: A secret scanning alert dismissal response was submitted. - operationId: dismissal-request-secret-scanning/response-submitted + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + description: Someone revoked their authorization of a GitHub App. + operationId: github-app-authorization/revoked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header @@ -69870,28 +71291,26 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: true + githubCloudOnly: false category: webhooks - subcategory: dismissal_request_secret_scanning + subcategory: github_app_authorization supported-webhook-types: - - repository - - organization - app - fork: + gollum: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: fork + operationId: gollum externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -69933,7 +71352,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-gollum" responses: '200': description: Return a 200 status to indicate that the data was received @@ -69941,24 +71360,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: fork + subcategory: gollum supported-webhook-types: - - business - repository - organization - app - github-app-authorization-revoked: + installation-created: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - - A GitHub App receives this webhook by default and cannot unsubscribe from this event. + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - description: Someone revoked their authorization of a GitHub App. - operationId: github-app-authorization/revoked + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + description: Someone installed a GitHub App on a user or organization account. + operationId: installation/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70000,7 +71416,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-installation-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70008,18 +71424,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: github_app_authorization + subcategory: installation supported-webhook-types: - app - gollum: + installation-deleted: post: summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: gollum + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. + description: Someone uninstalled a GitHub App from their user or organization + account. + operationId: installation/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70061,7 +71479,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70069,19 +71487,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: gollum + subcategory: installation supported-webhook-types: - - repository - - organization - app - installation-created: + installation-new-permissions-accepted: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone installed a GitHub App on a user or organization account. - operationId: installation/created + description: Someone granted new permissions to a GitHub App. + operationId: installation/new-permissions-accepted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: @@ -70125,7 +71541,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70136,17 +71552,16 @@ x-webhooks: subcategory: installation supported-webhook-types: - app - installation-deleted: + installation-repositories-added: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone uninstalled a GitHub App from their user or organization - account. - operationId: installation/deleted + description: A GitHub App installation was granted access to one or more repositories. + operationId: installation-repositories/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -70188,7 +71603,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-repositories-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70196,19 +71611,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: installation_repositories supported-webhook-types: - app - installation-new-permissions-accepted: + installation-repositories-removed: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone granted new permissions to a GitHub App. - operationId: installation/new-permissions-accepted + description: Access to one or more repositories was revoked for a GitHub App + installation. + operationId: installation-repositories/removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header @@ -70250,7 +71666,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70258,19 +71674,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: installation_repositories supported-webhook-types: - app - installation-repositories-added: + installation-suspend: post: summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: A GitHub App installation was granted access to one or more repositories. - operationId: installation-repositories/added + description: Someone blocked access by a GitHub App to their user or organization + account. + operationId: installation/suspend externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header @@ -70312,7 +71729,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-suspend" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70320,20 +71737,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_repositories + subcategory: installation supported-webhook-types: - app - installation-repositories-removed: + installation-target-renamed: post: - summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Access to one or more repositories was revoked for a GitHub App - installation. - operationId: installation-repositories/removed + summary: This event occurs when there is activity relating to the user or organization + account that a GitHub App is installed on. For more information, see "[About + apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." + For information about the APIs to manage GitHub Apps, see [the GraphQL API + documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in + the REST API documentation. + description: Somebody renamed the user or organization account that a GitHub + App is installed on. + operationId: installation-target/renamed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header @@ -70375,7 +71795,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-installation-target-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70383,18 +71803,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_repositories + subcategory: installation_target supported-webhook-types: - app - installation-suspend: + installation-unsuspend: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: Someone blocked access by a GitHub App to their user or organization - account. - operationId: installation/suspend + description: A GitHub App that was blocked from accessing a user or organization + account was given access the account again. + operationId: installation/unsuspend externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: @@ -70438,7 +71858,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-installation-unsuspend" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70449,20 +71869,18 @@ x-webhooks: subcategory: installation supported-webhook-types: - app - installation-target-renamed: + issue-comment-created: post: - summary: This event occurs when there is activity relating to the user or organization - account that a GitHub App is installed on. For more information, see "[About - apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." - For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) - or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in - the REST API documentation. - description: Somebody renamed the user or organization account that a GitHub - App is installed on. - operationId: installation-target/renamed + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was created. + operationId: issue-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -70504,7 +71922,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-issue-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70512,20 +71930,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation_target + subcategory: issue_comment supported-webhook-types: + - repository + - organization - app - installation-unsuspend: + issue-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. - description: A GitHub App that was blocked from accessing a user or organization - account was given access the account again. - operationId: installation/unsuspend + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -70567,7 +71988,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70575,10 +71996,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: installation + subcategory: issue_comment supported-webhook-types: + - repository + - organization - app - issue-comment-created: + issue-comment-edited: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. @@ -70586,8 +72009,8 @@ x-webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was created. - operationId: issue-comment/created + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -70631,7 +72054,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issue-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70644,18 +72067,18 @@ x-webhooks: - repository - organization - app - issue-comment-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -70697,7 +72120,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70705,23 +72128,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue_comment + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issue-comment-edited: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -70763,7 +72187,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70771,12 +72195,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue_comment + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issue-dependencies-blocked-by-added: + issue-dependencies-blocking-added: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. @@ -70784,8 +72208,8 @@ x-webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: @@ -70829,7 +72253,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70842,7 +72266,7 @@ x-webhooks: - repository - organization - app - issue-dependencies-blocked-by-removed: + issue-dependencies-blocking-removed: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. @@ -70850,9 +72274,9 @@ x-webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: @@ -70896,7 +72320,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70909,18 +72333,18 @@ x-webhooks: - repository - organization - app - issue-dependencies-blocking-added: + issues-assigned: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. - For activity relating to issues more generally, use the `issues` event instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocking another issue. - operationId: issue-dependencies/blocking-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -70962,7 +72386,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -70970,24 +72394,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issues supported-webhook-types: - repository - organization - app - issue-dependencies-blocking-removed: + issues-closed: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. - For activity relating to issues more generally, use the `issues` event instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was closed. + operationId: issues/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -71029,7 +72452,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71037,12 +72460,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issue-dependencies + subcategory: issues supported-webhook-types: - repository - organization - app - issues-assigned: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71050,8 +72473,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71095,7 +72518,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71108,7 +72531,7 @@ x-webhooks: - repository - organization - app - issues-closed: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71116,8 +72539,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71161,7 +72584,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71174,7 +72597,7 @@ x-webhooks: - repository - organization - app - issues-deleted: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71182,8 +72605,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71227,7 +72650,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71240,7 +72663,7 @@ x-webhooks: - repository - organization - app - issues-demilestoned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71248,8 +72671,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71293,7 +72716,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71306,7 +72729,7 @@ x-webhooks: - repository - organization - app - issues-edited: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71314,8 +72737,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71359,7 +72783,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71372,7 +72796,7 @@ x-webhooks: - repository - organization - app - issues-labeled: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71380,8 +72804,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71425,7 +72849,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71438,7 +72862,7 @@ x-webhooks: - repository - organization - app - issues-locked: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71446,9 +72870,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71492,7 +72916,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71505,7 +72929,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71513,8 +72937,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71558,7 +72983,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71571,7 +72996,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71579,9 +73004,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71625,7 +73049,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71638,7 +73062,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71646,9 +73070,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71692,7 +73116,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71705,7 +73129,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71713,8 +73137,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71758,7 +73182,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71771,7 +73195,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71779,9 +73203,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71825,7 +73248,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71838,7 +73261,7 @@ x-webhooks: - repository - organization - app - issues-typed: + issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71846,8 +73269,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71891,7 +73314,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71904,7 +73327,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71912,8 +73335,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -71957,7 +73381,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -71970,7 +73394,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-unpinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -71978,8 +73402,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72023,7 +73448,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72036,7 +73461,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-untyped: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72044,9 +73469,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72090,7 +73514,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72103,19 +73527,18 @@ x-webhooks: - repository - organization - app - issues-unpinned: + label-created: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was created. + operationId: label/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -72157,7 +73580,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72165,23 +73588,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: label supported-webhook-types: - repository - organization - app - issues-untyped: + label-deleted: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -72223,7 +73646,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72231,12 +73654,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: label supported-webhook-types: - repository - organization - app - label-created: + label-edited: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. @@ -72244,8 +73667,8 @@ x-webhooks: If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: @@ -72289,7 +73712,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72302,18 +73725,19 @@ x-webhooks: - repository - organization - app - label-deleted: + marketplace-purchase-cancelled: post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + in the REST API documentation. + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -72355,7 +73779,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72363,23 +73787,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: marketplace_purchase supported-webhook-types: - - repository - - organization - - app - label-edited: + - marketplace + marketplace-purchase-changed: post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" + in the REST API documentation. + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -72421,7 +73844,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72429,12 +73852,10 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: marketplace_purchase supported-webhook-types: - - repository - - organization - - app - marketplace-purchase-cancelled: + - marketplace + marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72442,9 +73863,11 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72488,7 +73911,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72499,7 +73922,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-changed: + marketplace-purchase-pending-change-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72507,9 +73930,10 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72553,7 +73977,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72564,7 +73988,7 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change: + marketplace-purchase-purchased: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." @@ -72572,11 +73996,9 @@ x-webhooks: [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: @@ -72620,7 +74042,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72631,20 +74053,16 @@ x-webhooks: subcategory: marketplace_purchase supported-webhook-types: - marketplace - marketplace-purchase-pending-change-cancelled: + member-added: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" - in the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + summary: |- + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -72686,7 +74104,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72694,22 +74112,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: member supported-webhook-types: - - marketplace - marketplace-purchase-purchased: + - business + - repository + - organization + - app + member-edited: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" - in the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + summary: |- + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -72751,7 +74169,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72759,17 +74177,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: member supported-webhook-types: - - marketplace - member-added: + - business + - repository + - organization + - app + member-removed: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: @@ -72813,7 +74234,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72827,16 +74248,80 @@ x-webhooks: - repository - organization - app - member-edited: + membership-added: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + description: An organization member was added to a team. + operationId: membership/added externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-membership-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: membership + supported-webhook-types: + - organization + - business + - app + membership-removed: + post: + summary: |- + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -72878,7 +74363,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-membership-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72886,22 +74371,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: membership supported-webhook-types: - - business - - repository - organization + - business - app - member-removed: + merge-group-checks-requested: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. + + When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. + operationId: merge-group/checks-requested + tags: + - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -72943,7 +74432,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -72951,22 +74440,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: merge_group supported-webhook-types: - - business - - repository - - organization - app - membership-added: + merge-group-destroyed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. + + When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. + operationId: merge-group/destroyed + tags: + - merge-queue externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -73008,7 +74499,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73016,21 +74507,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: merge_group supported-webhook-types: - - organization - - business - app - membership-removed: + meta-deleted: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to a webhook itself. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. + description: The webhook was deleted. + operationId: meta/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header @@ -73072,7 +74561,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-meta-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73080,26 +74569,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: meta supported-webhook-types: - - organization + - marketplace - business + - repository + - organization - app - merge-group-checks-requested: + milestone-closed: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. - operationId: merge-group/checks-requested - tags: - - merge-queue + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was closed. + operationId: milestone/closed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73141,7 +74629,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-milestone-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73149,24 +74637,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: milestone supported-webhook-types: + - repository + - organization - app - merge-group-destroyed: + milestone-created: post: summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. - operationId: merge-group/destroyed - tags: - - merge-queue + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was created. + operationId: milestone/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73208,7 +74695,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-milestone-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73216,19 +74703,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: milestone supported-webhook-types: + - repository + - organization - app - meta-deleted: + milestone-deleted: post: summary: |- - This event occurs when there is activity relating to a webhook itself. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. - description: The webhook was deleted. - operationId: meta/deleted + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was deleted. + operationId: milestone/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -73270,7 +74761,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-milestone-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73278,14 +74769,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: meta + subcategory: milestone supported-webhook-types: - - marketplace - - business - repository - organization - app - milestone-closed: + milestone-edited: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. @@ -73293,8 +74782,8 @@ x-webhooks: If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was closed. - operationId: milestone/closed + description: A milestone was edited. + operationId: milestone/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: @@ -73338,7 +74827,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73351,7 +74840,7 @@ x-webhooks: - repository - organization - app - milestone-created: + milestone-opened: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. @@ -73359,8 +74848,8 @@ x-webhooks: If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was created. - operationId: milestone/created + description: A milestone was opened. + operationId: milestone/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: @@ -73404,7 +74893,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73417,18 +74906,18 @@ x-webhooks: - repository - organization - app - milestone-deleted: + org-block-blocked: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was deleted. - operationId: milestone/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A user was blocked from the organization. + operationId: org-block/blocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -73470,7 +74959,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-org-block-blocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73478,23 +74967,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - milestone-edited: + org-block-unblocked: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was edited. - operationId: milestone/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A previously blocked user was unblocked from the organization. + operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -73536,7 +75025,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-org-block-unblocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -73544,23 +75033,79 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - milestone-opened: + organization-custom-property-created: post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was opened. - operationId: milestone/opened + summary: This event occurs when there is activity relating to an organization + custom property. + description: A new organization custom property was created. + operationId: organization-custom-property/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-organization-custom-property-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: organization_custom_property + supported-webhook-types: + - business + organization-custom-property-deleted: + post: + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was deleted. + operationId: organization-custom-property/deleted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -73602,31 +75147,25 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: milestone + subcategory: organization_custom_property supported-webhook-types: - - repository - - organization - - app - org-block-blocked: + - business + organization-custom-property-updated: post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A user was blocked from the organization. - operationId: org-block/blocked + summary: This event occurs when there is activity relating to an organization + custom property. + description: An organization custom property was updated. + operationId: organization-custom-property/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header @@ -73668,31 +75207,25 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: org_block + subcategory: organization_custom_property supported-webhook-types: - - organization - business - - app - org-block-unblocked: + organization-custom-property-values-updated: post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A previously blocked user was unblocked from the organization. - operationId: org-block/unblocked + summary: This event occurs when there is activity relating to custom property + values for an organization. + description: The custom property values of an organization were updated. + operationId: organization-custom-property-values/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values parameters: - name: User-Agent in: header @@ -73734,18 +75267,18 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: - githubCloudOnly: false + githubCloudOnly: true category: webhooks - subcategory: org_block + subcategory: organization-custom-property-values supported-webhook-types: - - organization - business + - organization - app organization-deleted: post: @@ -84292,6 +85825,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -84468,6 +86008,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin enterprise_organization_installations: type: string description: The level of permission to grant the access token to manage @@ -86163,6 +87711,10 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest required: - id - size_gb @@ -86270,6 +87822,9 @@ components: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -86278,6 +87833,84 @@ components: - status - public_ip_enabled - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image @@ -89100,6 +90733,51 @@ components: required: - date additionalProperties: true + copilot-usage-metrics-1-day-report: + type: object + title: Copilot Metrics 1 Day Report + description: Links to download the Copilot usage metrics report for an enterprise + for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the Copilot usage metrics report for the + enterprise for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + copilot-usage-metrics-28-day-report: + type: object + title: Copilot Metrics 28 Day Report + description: Links to download the latest Copilot usage metrics report for an + enterprise. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the latest Copilot usage metrics report + for the enterprise. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` format. + required: + - download_links + - report_start_day + - report_end_day dependabot-alert-package: type: object description: Details for the vulnerable package. @@ -89518,6 +91196,165 @@ components: - name - subnet_id - region + custom-property-base: + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete info about + this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + organization-custom-property: + title: Custom Property for Organization + description: Custom property defined for an organization + allOf: + - "$ref": "#/components/schemas/custom-property-base" + - type: object + properties: + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property + required: + - property_name + - value_type + organization-custom-property-payload: + title: Organization Custom Property Payload + description: Payload for creating or updating an organization custom property + definition on an enterprise. + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property. + description: + type: string + nullable: true + description: Short description of the property. + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - enterprise_actors + - enterprise_and_org_actors + example: enterprise_actors + description: Who can edit the values of the property. + required: + - value_type + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + custom-properties-for-orgs-get-enterprise-property-values: + title: Enterprise Organization Custom Property Values + description: List of custom property values for an organization + type: object + properties: + organization_id: + type: integer + example: 1296269 + organization_login: + type: string + example: Hello-World + properties: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + description: List of custom property names and associated values + required: + - organization_id + - organization_login + - properties custom-property: title: Organization Custom Property description: Custom property defined on an organization @@ -89887,6 +91724,21 @@ components: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and repositories + by property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" repository-rule-creation: title: creation description: Only allow users with bypass permission to create matching refs. @@ -91584,19 +93436,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -94950,19 +96802,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -95562,6 +97414,13 @@ components: enum: - open - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning campaign-summary: title: Campaign summary description: The campaign metadata and alert stats. @@ -99090,25 +100949,6 @@ components: - created_at - updated_at - archived_at - custom-property-value: - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -114139,19 +115979,19 @@ components: type: number description: Price per unit of the usage line item. grossQuantity: - type: integer + type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: - type: integer + type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: - type: integer + type: number description: Net quantity of the usage line item. netAmount: type: number @@ -153096,6 +154936,102 @@ components: - blocked_user - organization - sender + webhook-organization-custom-property-created: + title: organization custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: + "$ref": "#/components/schemas/organization-custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-deleted: + title: organization custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-updated: + title: organization custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/organization-custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition + - enterprise + webhook-organization-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + new_property_values: + type: array + description: The new custom property values. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - action + - organization + - enterprise + - new_property_values + - old_property_values webhook-organization-deleted: title: organization deleted event type: object @@ -223180,6 +225116,34 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' actions-hosted-runner-curated-image: value: id: ubuntu-20.04 @@ -224367,6 +226331,19 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 + copilot-usage-metrics-1-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + copilot-usage-metrics-28-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' dependabot-alerts-for-organization: value: - number: 2 @@ -224730,6 +226707,65 @@ components: name: my_network_settings subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: eastus + organization-custom-properties: + value: + properties: + - property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + - property_name: service + url: https://api.github.com/enterprises/github/org-properties/schema/service + source_type: enterprise + value_type: string + - property_name: team + url: https://api.github.com/enterprises/github/org-properties/schema/team + source_type: enterprise + value_type: string + description: Team owning the organization + organization-custom-property: + value: + property_name: environment + url: https://api.github.com/enterprises/github/org-properties/schema/environment + source_type: enterprise + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: enterprise_actors + custom-properties-for-orgs-get-enterprise-property-values: + value: + - organization_id: 1296269 + organization_login: Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + custom-properties-for-orgs-patch-enterprise-property-values: + value: + organization_logins: + - acme + - github + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat custom-properties: value: - property_name: environment @@ -225190,6 +227226,34 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -226565,20 +228629,6 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization organization-custom-repository-role-example: value: id: 8030 @@ -226674,6 +228724,23 @@ components: teams_url: https://api.github.com/repos/octocat/example-repo/teams trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat billing-premium-request-usage-report-org: value: timePeriod: @@ -227440,6 +229507,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -241374,23 +243447,6 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' - custom-property-values: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - create-or-update-custom-properties-values: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -250042,6 +252098,21 @@ components: required: true schema: type: string + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}